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

Fixing docstring for setDimension #1019

Merged
merged 2 commits into from
Dec 13, 2022

Conversation

john-science
Copy link
Member

Description

This was a documentation upgrade suggested by @jasonbmeng in Issue #1011


Checklist

  • This PR has only one purpose or idea.
  • 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 bug fixes or new features.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in setup.py.

@john-science john-science added the documentation Improvements or additions to documentation label Dec 11, 2022
@john-science john-science linked an issue Dec 11, 2022 that may be closed by this pull request
Copy link
Member

@keckler keckler left a comment

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 good change.

I would also propose that the way this method is written is kinda goofy. The logic makes it so we always calculate expansionFactor, whether or not it is used. This is (1) wasteful and (2) restricts us to only setting dimensions on components with materials that have the thermal expansion parameter defined.

Not super related to this PR, but just noticed it in the process of reviewing.

armi/reactor/components/component.py Outdated Show resolved Hide resolved
@john-science john-science merged commit 68d5c3b into terrapower:main Dec 13, 2022
@john-science john-science deleted the docstring_set_dimension branch December 13, 2022 14:10
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.

Misleading docstring for component.setDimension()
2 participants