Skip to content

Commit

Permalink
Fix docstring indentation
Browse files Browse the repository at this point in the history
  • Loading branch information
HunterMcGushion committed Oct 20, 2020
1 parent 4ee6203 commit d2ad8b8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions hyperparameter_hunter/i_o/recorders.py
Expand Up @@ -90,10 +90,10 @@ def result_path_key(self) -> str:
@abstractmethod
def required_attributes(self) -> list:
"""Return attributes of the current Experiment that are necessary to properly record result.
Specifically, `BaseRecorder` fetches the attrs via :class:`settings.G.Env.current_task`,
which can also be regarded as :class:`environment.Environment.current_task`, but this is
an implementation detail. It is simpler to use :class:`experiments.BaseExperiment`, and its
appropriate descendants as a reference for acceptable values of `required_attributes`"""
Specifically, `BaseRecorder` fetches the attrs via :class:`settings.G.Env.current_task`,
which can also be regarded as :class:`environment.Environment.current_task`, but this is
an implementation detail. It is simpler to use :class:`experiments.BaseExperiment`, and its
appropriate descendants as a reference for acceptable values of `required_attributes`"""

@abstractmethod
def format_result(self):
Expand Down

0 comments on commit d2ad8b8

Please sign in to comment.