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

Catchall PR for minor formatting/typo updates to docstrings #1634

Merged
merged 8 commits into from
Jan 29, 2024

Conversation

mgjarrett
Copy link
Contributor

@mgjarrett mgjarrett commented Jan 26, 2024

What is the change?

Typographical and formatting updates to docstrings and implementation detail that is going into the SQA docs for ARMI.

Why is the change being made?

Edits are being made as part of a review of the SQA documentation for ARMI.


Checklist

  • The release notes (location doc/release/0.X.rst) are up-to-date with any important changes.
  • The documentation is still up-to-date in the doc folder.
  • If any requirements were affected, mention it in the release notes.
  • The dependencies are still up-to-date in pyproject.toml.

tablefmt='rst'),
caption='List of elements')

.. only:: html
Copy link
Member

Choose a reason for hiding this comment

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

You know we have a ticket open for this, right?

#1624

Copy link
Member

Choose a reason for hiding this comment

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

@albeanth @mgjarrett This is certainly one of the main options in the ticket I linked. But I thought maybe we would discuss it first. I certainly think it doesn't belong in the API. But it could be somewhere else in the docs.

Thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

I think this is a fine band-aid solution but shouldn't be the long term solution.

Having a 109-page long table in the HTML is also not very useful. I think we should either 1) get rid of it, or 2) have a small table with ~10 nuclides as an example and reference the rest in a script that can be run.

@john-science john-science added the documentation Improvements or additions to documentation label Jan 27, 2024
@mgjarrett
Copy link
Contributor Author

@opotowsky @john-science I don't see any other fixes coming in. Should we merge this now?

@mgjarrett mgjarrett merged commit c374838 into main Jan 29, 2024
21 checks passed
@mgjarrett mgjarrett deleted the sdid_updates branch January 29, 2024 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants