[patch] Better docstrings

liamhuber commented 2 weeks ago

Not perfect, but closes #344

Fixing the creator and wrapper docstrings themselves will require first addressing #360

github-actions[bot] commented 2 weeks ago

:point_left: Launch a binder notebook on branch _pyiron/pyiron_workflow/betterdocstrings

codacy-production[bot] commented 2 weeks ago

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
:white_check_mark: +0.00% (target: -1.00%)	:white_check_mark: 83.33%

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (190d2fa13ac931f584602f52cb590c854771bd1c) | 3417 | 3162 | 92.54% | | | Head commit (8a1fd2a1e7e93d786aab58b7170f70a6f246e88a) | 3418 (+1) | 3163 (+1) | 92.54% (**+0.00%**) | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `

Diff coverage details

| | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#361) | 12 | 10 | **83.33%** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`

See your quality gate settings Change summary preferences

_{:rocket: Don’t miss a bit, follow what’s new on Codacy.}

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 9455721261

Details

0 of 0 changed or added relevant lines in 0 files are covered.
14 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.002%) to 92.539%

Files with Coverage Reduction	New Missed Lines	%
transform.py	2	98.13%
node_library/standard.py	12	92.0%
<!--	Total:	14	-->

Totals
Change from base Build 9421567056:	0.002%
Covered Lines:	3163
Relevant Lines:	3418

💛 - Coveralls

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 9455812687

Details

0 of 0 changed or added relevant lines in 0 files are covered.
13 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.002%) to 92.539%

Files with Coverage Reduction	New Missed Lines	%
transform.py	2	98.13%
node_library/standard.py	11	92.0%
<!--	Total:	13	-->

Totals
Change from base Build 9421567056:	0.002%
Covered Lines:	3163
Relevant Lines:	3418

pyiron / pyiron_workflow