From 177d61405bbbe63fb2190900668541f8c18cb68f Mon Sep 17 00:00:00 2001 From: Miriam Date: Tue, 9 Feb 2021 01:00:06 +0000 Subject: [PATCH 1/2] Docstring cleanup Changed docstring in openmc/lib/material.py and cell.py to resemble tally.py --- openmc/lib/cell.py | 5 +++++ openmc/lib/material.py | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/openmc/lib/cell.py b/openmc/lib/cell.py index 5903a1075..987de0899 100644 --- a/openmc/lib/cell.py +++ b/openmc/lib/cell.py @@ -66,6 +66,11 @@ class Cell(_FortranObjectWithID): Parameters ---------- + uid : int or None + Unique ID of the cell + new : bool + When `index` is None, this arfument controls whether a new object is + created or a view to an existing object is returned. index : int Index in the `cells` array. diff --git a/openmc/lib/material.py b/openmc/lib/material.py index f3c794778..6f80abb5e 100644 --- a/openmc/lib/material.py +++ b/openmc/lib/material.py @@ -74,7 +74,7 @@ class Material(_FortranObjectWithID): Parameters ---------- uid : int or None - Unique ID of the tally + Unique ID of the material new : bool When `index` is None, this argument controls whether a new object is created or a view to an existing object is returned. From 1c90b5de7195a03c97afda5ea71fb61928cef4d7 Mon Sep 17 00:00:00 2001 From: Miriam Date: Tue, 9 Feb 2021 01:14:04 +0000 Subject: [PATCH 2/2] typo --- openmc/lib/cell.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openmc/lib/cell.py b/openmc/lib/cell.py index 987de0899..c69d1e2a4 100644 --- a/openmc/lib/cell.py +++ b/openmc/lib/cell.py @@ -69,7 +69,7 @@ class Cell(_FortranObjectWithID): uid : int or None Unique ID of the cell new : bool - When `index` is None, this arfument controls whether a new object is + When `index` is None, this argument controls whether a new object is created or a view to an existing object is returned. index : int Index in the `cells` array.