terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality
https://terrapower.github.io/armi/
Apache License 2.0
232 stars 90 forks source link

Missing parameters in `findAssembly` docs #487

Closed keckler closed 2 years ago

keckler commented 2 years ago

The table in the docs that outlines how to select specific assemblies using the findAssembly method is incomplete. It is missing parameters which are accepted by findAssembly (see here).

Instead of just adding the missing parameters, it would probably be best to programmatically generate the table based on the docstring.

ntouran commented 2 years ago

Yeah we might want to just delete that table entirely and link to the auto-generated docs based on the docstring. (Our sphinx documentation system builds docs based on docstrings already): https://terrapower.github.io/armi/.apidocs/armi.physics.fuelCycle.fuelHandlers.html?highlight=findassembly#armi.physics.fuelCycle.fuelHandlers.FuelHandler.findAssembly