SpiceyPy icon indicating copy to clipboard operation
SpiceyPy copied to clipboard

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

Open jessie-dotson opened this issue 6 years ago • 3 comments

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. )

jessie-dotson avatar Feb 15 '20 19:02 jessie-dotson

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 https://github.com/openjournals/joss-reviews/issues/2050?

AndrewAnnex avatar Feb 15 '20 19:02 AndrewAnnex

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

AndrewAnnex avatar Feb 15 '20 19:02 AndrewAnnex

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...

jessie-dotson avatar Feb 15 '20 20:02 jessie-dotson