Skip to content

Commit

Permalink
Fix docstring errors
Browse files Browse the repository at this point in the history
  • Loading branch information
opcode81 committed Aug 3, 2023
1 parent 0154227 commit d0ee960
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
1 change: 1 addition & 0 deletions src/sensai/featuregen/feature_generator_registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ def _name(name: Hashable):
def register_factory(self, name: Hashable, factory: Callable[[], FeatureGenerator]):
"""
Registers a feature generator factory which can subsequently be referenced by models via their name/hashable key
:param name: the name/key (which can, in particular, be a string or an Enum item). Especially for larger projects
the use of an Enum is recommended (for optimal IDE support)
:param factory: the factory
Expand Down
1 change: 1 addition & 0 deletions src/sensai/util/profiling.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ def profiled(func: Optional[Callable] = None, *, sampling_interval_seconds: Opti
print_to_console=True, log_to_file=False, file_name: Optional[str] = None):
"""
Function decorator for profiling the annotated/given function with the pyinstrument profiler
:param func: the function to be profiled
:param sampling_interval_seconds: sampling every <sampling_interval_seconds> seconds, if None use default parameter of pyinstrument
profiler
Expand Down
16 changes: 8 additions & 8 deletions src/sensai/util/string.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,14 +160,14 @@ class ToStringMixin:
the class hierarchy.
.. document private functions
.. automethod:: _toStringClassName
.. automethod:: _toStringObjectInfo
.. automethod:: _toStringExcludes
.. automethod:: _toStringExcludeExceptions
.. automethod:: _toStringIncludes
.. automethod:: _toStringIncludesForced
.. automethod:: _toStringAdditionalEntries
.. automethod:: _toStringExcludePrivate
.. automethod:: _tostring_class_name
.. automethod:: _tostring_object_info
.. automethod:: _tostring_excludes
.. automethod:: _tostring_exclude_exceptions
.. automethod:: _tostring_includes
.. automethod:: _tostring_includes_forced
.. automethod:: _tostring_additional_entries
.. automethod:: _tostring_exclude_private
"""
_TOSTRING_INCLUDE_ALL = "__all__"

Expand Down

0 comments on commit d0ee960

Please sign in to comment.