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
224 stars 87 forks source link

Docstring for Block.getPinCoordinates incorrectly implies hex-only #1922

Open drewj-tp opened 2 days ago

drewj-tp commented 2 days ago

The docstring states

https://github.com/terrapower/armi/blob/f1f3dbea05c2564404a03d8e053f72c2af15daa9/armi/reactor/blocks.py#L1585-L1586

but the implementation is focused on the spatial locators attached to the children of the block

https://github.com/terrapower/armi/blob/f1f3dbea05c2564404a03d8e053f72c2af15daa9/armi/reactor/blocks.py#L1590-L1595

john-science commented 1 day ago

Good call. It looks to me like the comment about need Clad is sufficient.

We can remove this Notes section.