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

Fix sphinx/build_docs warnings for physics/speeds_of_gas_molecules #12471

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Fix sphinx/build_docs warnings for physics/speeds_of_gas_molecules #12471

wants to merge 6 commits into from

Conversation

MaximSmolskiy
Copy link
Member

Describe your change:

Fix sphinx/build_docs warnings for physics/speeds_of_gas_molecules

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Dec 24, 2024
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed tests are failing Do not merge until tests pass labels Dec 24, 2024
@MaximSmolskiy
Copy link
Member Author

@cclauss please review

cclauss
cclauss reviewed Dec 24, 2024
View reviewed changes
physics/speeds_of_gas_molecules.py
| f(v) = (M/2πRT)^(3/2) * 4πv^2 * e^(-Mv^2/2RT) |
-------------------------------------------------
.. math:: f(v) = \left(\frac{M}{2 \pi RT}\right)^{\frac{3}{2}} \cdot 4 \pi v^2
\cdot e^{-\frac{Mv^2}{2RT}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current text is readable by human code readers, while the second forces the reader to open the docs to understand the formula. Would it be possible/useful to keep both the new and the old?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@MaximSmolskiy MaximSmolskiy force-pushed the fix-sphinx/build_docs-warning-for-physics/speeds_of_gas_molecules branch from 5aba01b to e6ed32e Compare December 24, 2024 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss Awaiting requested review from cclauss

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
awaiting reviews This PR is ready to be reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@MaximSmolskiy @cclauss