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

Improving docs: settings report and missing impl text #1629

Merged
merged 2 commits into from
Jan 25, 2024

Conversation

john-science
Copy link
Member

What is the change?

This PR aims to fix two different doc issues:

  1. Removing file paths from the Settings Report (it looks tacky)
  2. There was an impl tag with no text

Checklist

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

@john-science john-science added the documentation Improvements or additions to documentation label Jan 25, 2024
armi/reactor/components/__init__.py Outdated Show resolved Hide resolved
doc/user/inputs.rst Outdated Show resolved Hide resolved
Co-authored-by: Arrielle Opotowsky <c-aopotowsky@terrapower.com>
@john-science john-science merged commit 0145550 into main Jan 25, 2024
21 checks passed
@john-science john-science deleted the doc_settings_report_defaults branch January 25, 2024 23:46
content += ' - {}\n'.format(' '.join(['``{}``'.format(wrapped) for wrapped in wrapper.wrap(str(getattr(setting,'options','') or ''))]))
default = str(getattr(setting, 'default', None)).split("/")[-1]
options = str(getattr(setting,'options','') or '')
if looks_like_path(defaults):
Copy link
Contributor

Choose a reason for hiding this comment

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

Something is wonky here. I don't see where defaults (with the s) is defined.

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.

3 participants