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

Ocean/pc doc201 #3601

Draft
wants to merge 4 commits into
base: doc201
Choose a base branch
from
Draft

Ocean/pc doc201 #3601

wants to merge 4 commits into from

Conversation

OceanNuclear
Copy link
Contributor

@OceanNuclear OceanNuclear commented Sep 10, 2024

Linked Issues

Closes #3600

Description

Add return docs into bluemira/radiation_transport.py

Interface Changes

N/A

Checklist

I confirm that I have completed the following checks:

  • Tests run locally and pass pytest tests --reactor
  • Code quality checks run locally and pass pre-commit run --from-ref develop --to-ref HEAD
  • Documentation built locally and checked sphinx-build -W documentation/source documentation/build

📚 Documentation preview 📚: https://bluemira--3601.org.readthedocs.build/en/3601/

@je-cook je-cook added documentation Improvements or additions to documentation quality Tasks relating to quality issues or improvements labels Sep 10, 2024
Copy link
Contributor

@je-cook je-cook left a comment

Choose a reason for hiding this comment

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

Just a few little ones on so far

bluemira/radiation_transport/advective_transport.py Outdated Show resolved Hide resolved
bluemira/radiation_transport/advective_transport.py Outdated Show resolved Hide resolved
@OceanNuclear
Copy link
Contributor Author

One of the static method in advective_transport was identical to the function of the same name in flux_surfaces_maker, so I've removed the former definition, and instead imported it from the latter file.

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 quality Tasks relating to quality issues or improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants