Parse docstrings for nested argument models #436

ychiucco · 2023-06-20T07:09:59Z

closes #418

github-actions · 2023-06-20T07:21:36Z

Coverage report

The coverage rate went from 84.2% to 84.23% ⬆️
The branch rate is 78%.

100% of new lines are covered.

Diff Coverage details (click to unfold)

fractal_tasks_core/lib_channels.py

100% of new lines are covered (91.56% of the complete file).

fractal_tasks_core/lib_input_models.py

100% of new lines are covered (100% of the complete file).

…hub.com:fractal-analytics-platform/fractal-tasks-core into 418-parse-docstrings-for-nested-argument-models

…s-for-nested-argument-models' into 418-parse-docstrings-for-nested-argument-models

…hub.com:fractal-analytics-platform/fractal-tasks-core into 418-parse-docstrings-for-nested-argument-models

…s-for-nested-argument-models' into 418-parse-docstrings-for-nested-argument-models

fractal_tasks_core/dev/lib_descriptions.py

fractal_tasks_core/dev/lib_args_schemas.py

tests/test_unit_lib_descriptions.py

…ions in lib_descriptions.py

1. Remove `test_descriptions`, since it would always fail because descriptions are already in the manifest; 2. Update other tests.

moved functions and hardcoded inner pydantic models

fa616a2

ychiucco linked an issue Jun 20, 2023 that may be closed by this pull request

Parse docstrings for nested argument models #418

Closed

ychiucco and others added 24 commits June 20, 2023 10:52

extract docstrings and var descriptions

102d63a

docstring to __docstring__

074c36f

moved function and add docs

1a8512b

change func name

d52a6af

implement _include_attributs_descriptions_in_schema

818f17b

BROKEN stash

5b28e54

Merge branch 'main' into 418-parse-docstrings-for-nested-argument-models

2e46584

fix _include_attributs_descriptions_in_schema and test

75b18f4

change log warning to raise error

b9e098f

Update autodoc_member_orderautodoc_member_order option in docs

f3a601e

Merge branch '418-parse-docstrings-for-nested-argument-models' of git…

8c7c676

…hub.com:fractal-analytics-platform/fractal-tasks-core into 418-parse-docstrings-for-nested-argument-models

Fix precommit

cc0400f

class attribute docstrings back to """..."""

b11fc4e

Simplify docstring to fix docs build

e35555f

STASH

36b072a

Merge remote-tracking branch 'refs/remotes/origin/418-parse-docstring…

e6ec0f6

…s-for-nested-argument-models' into 418-parse-docstrings-for-nested-argument-models

Improve docstrings (ref #421)

10f2157

Update manifest

78579e3

Merge branch '418-parse-docstrings-for-nested-argument-models' of git…

2ea7ec2

…hub.com:fractal-analytics-platform/fractal-tasks-core into 418-parse-docstrings-for-nested-argument-models

Minor fix to docs config

932aa6b

implement _get_function_args_descriptions

daed7e1

separate tests

4a4b993

Merge remote-tracking branch 'refs/remotes/origin/418-parse-docstring…

3d189e6

…s-for-nested-argument-models' into 418-parse-docstrings-for-nested-argument-models

implement _get_class_attrs_descriptions and test

b3dd0b2