Docstrings refactoring

[DenisSidoren]

refactoring

[pep8speaks]

Hello @DenisSidoren! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file fedot/core/composer/composer.py:

Line 15:1: F811 redefinition of unused 'ComposerRequirements' from line 9 Line 44:30: F541 f-string is missing placeholders Line 46:30: F541 f-string is missing placeholders Line 48:30: F541 f-string is missing placeholders Line 50:30: F541 f-string is missing placeholders

• In the file fedot/core/dag/graph.py:

Line 3:1: F401 'typing.Any' imported but unused Line 3:1: F401 'typing.Generic' imported but unused

• In the file fedot/core/data/data.py:

Line 281:17: F402 import 'field' from line 4 shadowed by loop variable

• In the file fedot/core/operations/data_operation.py:

Line 1:1: F401 'typing.Optional' imported but unused

• In the file fedot/core/operations/evaluation/operation_implementations/data_operations/sklearn_transformations.py:

Line 2:1: F401 'typing.Union' imported but unused Line 2:1: F401 'typing.List' imported but unused Line 2:1: F401 'typing.Tuple' imported but unused

• In the file fedot/core/operations/evaluation/operation_implementations/data_operations/ts_transformations.py:

Line 2:1: F401 'typing.Optional' imported but unused Line 251:28: F541 f-string is missing placeholders

• In the file fedot/core/optimisers/graph.py:

Line 5:1: F401 'fedot.core.dag.graph_operator.GraphOperator' imported but unused Line 6:1: F401 'fedot.core.log.Log' imported but unused Line 11:1: E302 expected 2 blank lines, found 1

• In the file fedot/core/pipelines/tuning/tuner_interface.py:

Line 20:1: W293 blank line contains whitespace Line 64:1: W293 blank line contains whitespace Line 123:38: W292 no newline at end of file

• In the file fedot/preprocessing/data_types.py:

Line 55:42: F821 undefined name 'InputData' Line 85:46: F821 undefined name 'InputData' Line 200:66: F821 undefined name 'InputData' Line 283:71: F821 undefined name 'InputData' Line 312:75: F821 undefined name 'InputData' Line 330:67: F821 undefined name 'InputData' Line 369:71: F821 undefined name 'InputData'

• In the file fedot/sensitivity/node_sa_approaches.py:

Line 311:9: F841 local variable 'app_data_operations' is assigned to but never used Line 351:26: E127 continuation line over-indented for visual indent

• In the file fedot/sensitivity/nodes_sensitivity.py:

Line 8:1: F401 'fedot.core.dag.graph_operator.GraphOperator' imported but unused Line 74:71: E502 the backslash is redundant between brackets

• In the file fedot/sensitivity/operations_hp_sensitivity/multi_operations_sensitivity.py:

Line 48:17: E127 continuation line over-indented for visual indent

• In the file fedot/sensitivity/operations_hp_sensitivity/one_operation_sensitivity.py:

Line 4:1: F401 'typing.Optional' imported but unused

• In the file fedot/sensitivity/pipeline_sensitivity_facade.py:

Line 54:76: F821 undefined name 'log' Line 62:55: F821 undefined name 'log'

• In the file fedot/utilities/profiler/time_profiler.py:

Line 9:5: F401 'gprof2dot' imported but unused Line 13:5: F401 'snakeviz' imported but unused

Comment last updated at 2022-09-13 13:11:36 UTC

[codecov[bot]]

Codecov Report

Merging #807 (7460563) into master (254e984) will increase coverage by 0.35%. The diff coverage is 79.48%.

:exclamation: Current head 7460563 differs from pull request most recent head c4c54b8. Consider uploading reports for the commit c4c54b8 to get more accurate results

@@            Coverage Diff             @@
##           master     #807      +/-   ##
==========================================
+ Coverage   87.92%   88.27%   +0.35%     
==========================================
  Files         196      196              
  Lines       13383    13368      -15     
==========================================
+ Hits        11767    11801      +34     
+ Misses       1616     1567      -49     

Impacted Files	Coverage Δ
fedot/core/dag/graph.py	77.21% <ø> (ø)
fedot/core/log.py	92.04% <ø> (ø)
fedot/core/operations/data_operation.py	94.11% <ø> (ø)
...ore/operations/evaluation/evaluation_interfaces.py	90.43% <ø> (ø)
fedot/core/operations/model.py	100.00% <ø> (ø)
fedot/core/operations/operation.py	96.38% <ø> (ø)
fedot/core/optimisers/graph.py	100.00% <ø> (ø)
fedot/core/pipelines/node.py	96.60% <ø> (ø)
fedot/core/pipelines/pipeline.py	96.87% <ø> (+0.62%)	:arrow_up:
fedot/core/repository/dataset_types.py	100.00% <ø> (ø)
... and 20 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[MorrisNein]

1. Не нашёл метода Pipeline.show в документации, хотя вроде он должен быть задокументирован по аналогии с Graph.show
2. OptHistory класс достаточно важный, но я при беглом просмотре его не нашёл
3. Раздел Optimizations хранит доку на класс GraphDelegate, мне кажется это контринтуитивным. Или так и должно быть?