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

Improve documentation to methods #750

Open
mcara opened this issue Jun 23, 2020 · 0 comments
Open

Improve documentation to methods #750

mcara opened this issue Jun 23, 2020 · 0 comments

Comments

@mcara
Copy link
Member

mcara commented Jun 23, 2020

Documentation for assign_bestrefs https://hst-crds.stsci.edu/static/users_guide/library_use.html#crds-assign-bestrefs should be improved and describe expected argument type and what arguments do. I came across a case when user was setting filepaths='ie6d07ujq_flc.fits' (as an example) and then CRDS erred with messages that it cannot find files i, e, 6, d, ...

It would be great if CRDS documentation could follow style guide https://github.com/spacetelescope/style-guides/blob/06111fd0e4054f7835a6cd83dec3ce9049b3b970/guides/python.md#docstrings. Other functions seems to be documented slightly better but each has its own style.

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

1 participant