Skip to content

Commit

Permalink
Changed reference to Property.empty to Property._empty
Browse files Browse the repository at this point in the history
  • Loading branch information
gawebb-dstl committed Oct 8, 2024
1 parent fe304f4 commit 83be47e
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions stonesoup/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ class Property:
A default value can be specified to signify the property on the class is
optional. As ``None`` and ``False`` are reasonable default values,
:class:`inspect.Parameter.empty` is used to signify the argument is
mandatory. (Also aliased to :attr:`Property.empty` for ease)
mandatory. (Also aliased to :attr:`Property._empty` for ease)
A description string can also be provided which will be rendered in the
documentation.
Expand All @@ -99,7 +99,7 @@ class Property:
and providing both will raise an error.
default : any, optional
A default value, which should be same type as class or None. Defaults
to :class:`inspect.Parameter.empty` (alias :attr:`Property.empty`)
to :class:`inspect.Parameter.empty` (alias :attr:`Property._empty`)
doc : str, optional
Doc string for property
readonly : bool, optional
Expand All @@ -113,6 +113,9 @@ class Property:
readonly
_empty : :class:`inspect.Parameter.empty`
Alias to :class:`inspect.Parameter.empty`
MISSING
A singleton to indicator a value is missing and default value
should be created.
"""
_empty = inspect.Parameter.empty
MISSING = _MISSING()
Expand Down

0 comments on commit 83be47e

Please sign in to comment.