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.

Sign up for GitHub

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

Jump to bottom

Fix docstring for Model.plot #3198

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Fix docstring for Model.plot #3198

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions openmc/model/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -820,14 +820,14 @@ def plot(

Parameters
----------
n_samples : dict
n_samples : int, optional
The number of source particles to sample and add to plot. Defaults
to None which doesn't plot any particles on the plot.
plane_tolerance: float
When plotting a plane the source locations within the plane +/-
the plane_tolerance will be included and those outside of the
plane_tolerance will not be shown
source_kwargs : dict
source_kwargs : dict, optional
Keyword arguments passed to :func:`matplotlib.pyplot.scatter`.
**kwargs
Keyword arguments passed to :func:`openmc.Universe.plot`
Expand Down