Skip to content

Unclear parameters in exo handler #304

@ppinchuk

Description

@ppinchuk

sup3r version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://natlabrockies.github.io/sup3r/_autosummary/sup3r.preprocessing.rasterizers.exo.BaseExoRasterizer.html#sup3r.preprocessing.rasterizers.exo.BaseExoRasterizer

Documentation problem

The relationship/difference between file_paths and source_files as well as input_handler_kwargs and source_handler_kwargs is not entirely obvious for a newcome to sup3r like me. It's possible that you explain this difference somewhere in a tutorial, which would be on me for not looking.

Suggested fix for documentation

Either clarify the purpose, relationship, or difference between the two different inputs or provide a clickable link to an example that new users can reference to understand the difference between the two inputs and what they represent/why they are required for the exo inputs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions