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

DOC: Major overhaul of scipy.constants documentation? #11173

Open
jakobjakobson13 opened this issue Dec 4, 2019 · 1 comment
Open

DOC: Major overhaul of scipy.constants documentation? #11173

jakobjakobson13 opened this issue Dec 4, 2019 · 1 comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.constants

Comments

@jakobjakobson13
Copy link
Contributor

Hi,

I personally find the scipy.constants a not very concise collection of units and constants.
If you don't have any objections, I would write up a draft following the SI-brochure. This could either mean a restructured and extended documentation leaving all the existing information on the page or a slimmed down variant that drops the units that are not part of the SI conventions.

Regards

@tylerjereddy tylerjereddy added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.constants labels Dec 4, 2019
@rgommers
Copy link
Member

rgommers commented Dec 4, 2019

Agreed, thanks @jakobjakobson13. In particular the huge list of physical constants is a bit jarring. Slimming down that page and moving things to subpages with some logic that follows the SI brochure seems like a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.constants
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants