Skip to content

improve utils.chemistry docs #722

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
Merged
bobmyhill merged 1 commit into from
Dec 9, 2025
Merged

improve utils.chemistry docs #722

bobmyhill merged 1 commit into from
Dec 9, 2025

Conversation

@bobmyhill
Copy link
Member

@bobmyhill bobmyhill commented Dec 9, 2025

This pull request:

  • Adds autodata directives for IUPAC_element_order and atomic_masses in docs/api_utils.rst, making the values of these data structures appear in the docs.
  • Replaced block docstrings for atomic_masses and IUPAC_element_order in burnman/utils/chemistry.py with inline sphinx-read comments (<code> #: ...)

@bobmyhill bobmyhill merged commit df429e9 into geodynamics:main Dec 9, 2025
11 of 12 checks passed
@bobmyhill bobmyhill added this to the 3.0 milestone Dec 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

3.0

Development

Successfully merging this pull request may close these issues.

1 participant

@bobmyhill