crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-26 13:15:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Simplify sampling function name in doc

Browse source 
sample_source -> sample
This commit is contained in:
Dan Short 2020-08-28 09:37:28 +01:00
parent 798b66a527
commit cf656032f7
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/io_formats/settings.rst
View file

@ -466,7 +466,7 @@ attributes/sub-elements:
has a few basic requirements:
* It must contain a class that inherits from ``openmc::CustomSource``;
* The class must implement a function called ``sample_source()``;
* The class must implement a function called ``sample()``;
* There must be an ``openmc_create_source()`` function that creates the source
as a unique pointer. This function can be used to pass parameters through to
the source from the XML, if needed.