Skip to content

MAINT: constants: slim down module #17577

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
Closed
wants to merge 38 commits into from
Closed

MAINT: constants: slim down module #17577

wants to merge 38 commits into from

Conversation

jakobjakobson13
Copy link
Contributor

@jakobjakobson13 jakobjakobson13 commented Dec 10, 2022 •
edited
Loading

A draft for a slimmed down scipy.constants module, see #11682 and #17571 .
The main idea is the following:

  • Remove all non-CODATA constants and variables and any references to them, leaving only CODATA constants in the module.
  • List only the calculated values with their name and uncertainty in the documentation (of course with the links). For further documentation refer to the SI brochure.
  • Split the parsing/calculationsof the CODATA constants from the raw data in _codata.py. Transfer the CODATA raw data either into one dedicated data file or data directory. Alternatively use Pooch (preferable in terms of reproducibility and data consistency, also spares issues like BUG: Missing Constant in Documentation #16068 (comment))

This pull request is not ready for merging yet.

@jakobjakobson13 jakobjakobson13 changed the title Slim down constant doc DRAFT: Slim down scipy.constant doc Dec 10, 2022
@jakobjakobson13 jakobjakobson13 changed the title DRAFT: Slim down scipy.constant doc DRAFT: Slim down scipy.constant modul Dec 12, 2022
@j-bowhay j-bowhay added enhancement A new feature or improvement scipy.constants labels Jan 10, 2023
This was referenced Feb 8, 2024
Open
Open
@lucascolley lucascolley added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org maintenance Items related to regular maintenance tasks and removed enhancement A new feature or improvement Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Feb 9, 2024
@AlexSzatmary AlexSzatmary mentioned this pull request Feb 11, 2024
Merged
@lucascolley lucascolley changed the title DRAFT: Slim down scipy.constant modul MAINT: constants: slim down module Mar 14, 2024
@jakobjakobson13 jakobjakobson13 mentioned this pull request Apr 9, 2024
Closed
@jakobjakobson13
Copy link
Contributor Author

I'm closing this one as it's too disruptive.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tylerjereddy tylerjereddy Awaiting requested review from tylerjereddy tylerjereddy will be requested when the pull request is marked ready for review tylerjereddy is a code owner

@peterbell10 peterbell10 Awaiting requested review from peterbell10 peterbell10 will be requested when the pull request is marked ready for review peterbell10 is a code owner

@rgommers rgommers Awaiting requested review from rgommers rgommers will be requested when the pull request is marked ready for review rgommers is a code owner

Assignees
No one assigned
Labels
maintenance Items related to regular maintenance tasks scipy.constants
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jakobjakobson13 @lucascolley @j-bowhay