Skip to content

Improve Field default docstring #3064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maxnoe wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −2
Open

Improve Field default docstring #3064

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/ctapipe/core/container.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,9 @@ class Field[T]:
default :
Default value of the item. This will be set when the `Container`
is constructed, as well as when ``Container.reset`` is called.
This should only be used for immutable values. For mutable values,
use ``default_factory`` instead.
The value passed to ``default`` should be immutable, as it is
assigned as is to each new container instance.
For mutable default values, use ``default_factory`` instead.
description : str
Help text associated with the item
unit : str or astropy.units.core.UnitBase
Expand Down
Loading