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

Update documentation around use of source classes #2679

Merged
merged 1 commit into from
Sep 2, 2023

Conversation

paulromano
Copy link
Contributor

Description

I noticed that our documentation still mentions openmc.Source in quite a few places which needs to be updated to openmc.IndependentSource after #2524. There were also some mentions of CustomSource, which generally we prefer to be called CompiledSource now.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format on any C++ source files (if applicable)
  • I have followed the style guidelines for Python source files (if applicable)
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

@paulromano paulromano requested a review from pshriwise September 1, 2023 19:53
@shimwell shimwell self-assigned this Sep 1, 2023
Copy link
Member

@shimwell shimwell left a comment

Choose a reason for hiding this comment

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

Changes look good on git and on readthedocs. Thanks for also removing Nuclide, Element
and Macroscopic.

As these are doc changes and not complicated I've enabled the auto merge once the tests pass

@shimwell shimwell enabled auto-merge (squash) September 1, 2023 21:10
@shimwell shimwell merged commit 7a13bf6 into openmc-dev:develop Sep 2, 2023
@paulromano paulromano deleted the update-source-docs branch September 3, 2023 19:56
stchaker pushed a commit to stchaker/openmc that referenced this pull request Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants