Remove undefined acronyms from requirements + fix broken links - Githubissues

terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality

https://terrapower.github.io/armi/

Apache License 2.0

224 stars 87 forks source link

Remove undefined acronyms from requirements + fix broken links #1628

Closed albeanth closed 8 months ago

albeanth commented 8 months ago

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.~

[x] The code style follows good practices.
[x] The commit message(s) follow good practices.

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