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

Remove undefined acronyms from requirements + fix broken links #1628

Merged
merged 6 commits into from
Jan 26, 2024

Conversation

albeanth
Copy link
Member

@albeanth albeanth commented Jan 25, 2024

What is the change?

When SQA documentation is generated, these acronyms (though commonly known internally and by SMEs) are technically undefined. We shouldn't have that.

Also sneaking in a couple of broken links.

Why is the change being made?

SQA efforts.


Checklist

  • This PR has only one purpose or idea. It did at one point. See above.
  • Tests have been added/updated to verify that the new/changed code works.
  • 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.

@albeanth albeanth added the documentation Improvements or additions to documentation label Jan 25, 2024
@albeanth albeanth changed the title Remove undefined acronyms from requirements Remove undefined acronyms from requirements + fix broken links Jan 25, 2024
@albeanth albeanth requested review from john-science and removed request for zachmprince January 25, 2024 23:24
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.

Third time's a charm!

@john-science john-science merged commit ffa519b into terrapower:main Jan 26, 2024
11 checks passed
@albeanth albeanth deleted the define_acronyms branch June 9, 2024 16:44
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.

2 participants