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.

Sign up for GitHub

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

Jump to bottom

Improve module docstrings in "scimath.units" #119

Open
rahulporuri opened this issue Jun 25, 2021 · 1 comment
Open

Improve module docstrings in "scimath.units" #119

rahulporuri opened this issue Jun 25, 2021 · 1 comment
Assignees
@homosapien-lcy

Comments

@rahulporuri
Copy link
Contributor

At the moment, https://docs.enthought.com/scimath/units/available_units.html contains documentation on the available units in the various modules of scimath.units. Along with this, it would be useful to have API documentation which contains the same information. The PR #116 removes some of the module docstrings in scimath.units.* - which we would like to add back, along with adding module docstrings for the rest of the subpackage.
@homosapien-lcy
Copy link
Contributor

Just want to clarify, do you mean adding thing like (red minus codes)
Screen Shot 2023-03-08 at 5.35.07 PM.png for all the unit defining files (such as units.area, units.energy)?

@homosapien-lcy homosapien-lcy self-assigned this Mar 8, 2023
@homosapien-lcy homosapien-lcy mentioned this issue Mar 20, 2023
Merged
homosapien-lcy added a commit that referenced this issue Mar 30, 2023
@homosapien-lcy
DOC: add docstrings to units (#172)
e06e318 
As mentioned in issue #119 , it can help the users a great bit if we add
doc string to the unit api. (Just realized there are so many different
metric systems we have around the world...)

---------

Co-authored-by: Chengyu Liu <cyliu@aus552cyliu.local>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@homosapien-lcy homosapien-lcy

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rahulporuri @homosapien-lcy