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

Reducing the number of warnings when building docs #1769

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

zachmprince
Copy link
Contributor

@zachmprince zachmprince commented Jul 8, 2024

What is the change?

This PR mainly includes minor fixes to reduce errors/warnings during the documentation build. Here are a list of things included:

  • Escaping RST special characters
  • Formatting pieces of documentation that should be rendered as code
  • Making various type definitions more explicit to avoid warnings there are multiple possible interpretations
  • Removing duplicate references
  • Making some links "anonymous"
  • Removing API headings that aren't allowed by numpy code standards
  • Formatting multiline lists properly
  • Various black/ruff formatting

A more significant change includes modifications to the dochelpers package. This includes:

  • A new function that escapes special characters in a inputted string. This is used in the parameter and settings report table functions, which were including special characters from the descriptions.
  • The ability to a label to created tables

Why is the change being made?

This somewhat of a "basic" maintenance PR: making docs render properly. On a more practical level, reducing the number of warnings when building docs helps pick out future bugs written in the documentation.


Checklist

  • The release notes have been updated if necessary.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in pyproject.toml.

@zachmprince zachmprince added documentation Improvements or additions to documentation cleanup Code/comment cleanup: Low Priority labels Jul 8, 2024
armi/materials/thU.py Outdated Show resolved Hide resolved
Copy link
Member

@john-science john-science left a comment

Choose a reason for hiding this comment

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

Looks great!

@john-science john-science merged commit 9fa5cd4 into terrapower:main Jul 10, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Code/comment cleanup: Low Priority documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants