Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make_output_path components is poorly documented #189

Open
emolter opened this issue Sep 24, 2024 · 2 comments
Open

make_output_path components is poorly documented #189

emolter opened this issue Sep 24, 2024 · 2 comments

Comments

@emolter
Copy link
Collaborator

emolter commented Sep 24, 2024

The documentation here is confusing for the components argument to make_output_path. An example would be extremely helpful. Digging into the code for 20 minutes, I still couldn't figure out what the format of this is supposed to be.

If I pass in any old dictionary, e.g. {"asn_id":"foo", "slit_name":"bar"} it seems to interpret that as a string literal.

There is also no example making use of the components keyword argument in the docs here.

@stscieisenhamer
Copy link
Collaborator

guilty party here and available for consultation after end of current sprint (7oct24)

@emolter
Copy link
Collaborator Author

emolter commented Sep 26, 2024

Thanks @stscieisenhamer. I think part of my confusion was coming from usage of functools.partial operating on the components kwargs of make_output_path upstream of where I got confused, which is my fault. However I still think some additional documentation and examples would be helpful

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants