Skip to content

Commit c2c6438

Browse files
committed
update docstring
Signed-off-by: Thijs Baaijen <13253091+Thijss@users.noreply.github.com>
1 parent 273e78c commit c2c6438

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

  • src/power_grid_model_ds/_core/model/arrays/base

src/power_grid_model_ds/_core/model/arrays/base/array.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,15 @@ class FancyArray(ABC): # noqa: B024
4949
which is a dictionary mapping column names to their default values.
5050
The _defaults attribute is inherited by child classes.
5151
52-
Note on string-columns:
52+
Note on string columns:
5353
The default length for string columns is stored in _DEFAULT_STR_LENGTH.
5454
To change this, you can set the _str_lengths class attribute.
5555
The _str_lengths attribute is inherited by child classes.
5656
57-
Note on id-columns:
57+
Note on id columns:
5858
Columns that contain ids or reference ids (e.g., 'id', 'from_node', etc.) should be defined in the _id_columns
59-
class attribute to ensure correct functionality of grid.merge
59+
class attribute to ensure correct functionality of grid.merge()
60+
The _id_columns attribute is inherited by child classes.
6061
6162
Example:
6263
>>> class MyArray(FancyArray):

0 commit comments

Comments
 (0)