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

Modest suggestion to improve help() documentation -- include units #350

Open
jessie-dotson opened this issue Feb 15, 2020 · 3 comments
Open
Labels
beginners welcome issues that are good for beginners documentation

Comments

@jessie-dotson
Copy link

The help() function is super useful. Kudos for including the links to the more complete function documentation at the NAIF. One way to make the info returned by help() even more useful would be to include units where ever the units are constants. ( For instance, the NAIF documentation for spkpos specifies that the positions are always in km and the light travel time is always on seconds. )

@AndrewAnnex
Copy link
Owner

hey @jessie-dotson thanks for the suggestion,
I've searched the html source files for instances where "units" are specified and made the attached file, units_in_docs.txt. It doesn't look like too much work, but is this a blocker for the review at openjournals/joss-reviews#2050?

@AndrewAnnex
Copy link
Owner

this could be turned into a GSoC issue fairly easily also...

@AndrewAnnex AndrewAnnex added beginners welcome issues that are good for beginners documentation labels Feb 15, 2020
@jessie-dotson
Copy link
Author

Totally not a blocker for the JOSS review. Just something that occurred to me could make it easier for users while walking through the package...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginners welcome issues that are good for beginners documentation
Projects
None yet
Development

No branches or pull requests

2 participants