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

Mostly parameters related updates to docs #1919

Merged
merged 4 commits into from
Oct 1, 2024
Merged

Conversation

opotowsky
Copy link
Member

@opotowsky opotowsky commented Sep 30, 2024

What is the change?

Some docs/docstring edits!

Giving more links to the parameter module intro as well as adding info about how to get units of a parameter.

Also added a little clarification based on a stumble they had while walking through the user manual (the UM leads you to have r, not o.r, but there's plenty of ways you end up with one or the other)

Why is the change being made?

A user was asking me some questions, and it exposed some potential docs improvements.


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.

@opotowsky opotowsky added the documentation Improvements or additions to documentation label Sep 30, 2024
@opotowsky opotowsky linked an issue Sep 30, 2024 that may be closed by this pull request
@opotowsky
Copy link
Member Author

John, let me know if the docs updates also get added to the release notes.

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.

I love your change to armi/reactor/parameters/__init__.py!

(This needs a SCRE.)

@opotowsky
Copy link
Member Author

I love your change to armi/reactor/parameters/__init__.py!

(This needs a SCRE.)

We don't need them anymore :-)

@john-science john-science merged commit f1f3dbe into main Oct 1, 2024
15 checks passed
@john-science john-science deleted the little-docs-things branch October 1, 2024 22:52
drewj-tp added a commit that referenced this pull request Oct 8, 2024
…xial-linkage

* origin/main:
  Adding support for ex-core structures (#1891)
  Fixing edge case in assemblyBlueprint._checkParamConsistency (#1929)
  Improving the robustness of  HexBlock._rotatePins() (#1859)
  Removing unnecessary column in print-out (#1925)
  Updating parameter-related docs (#1919)
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.

Parameters package documentation
2 participants