Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] wip: update docstrings for core.py #317

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

nicolocin
Copy link
Collaborator

@nicolocin nicolocin commented Jul 16, 2020

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Summary

Update docstrings for pydra.engine.core. Maybe pydra.engine.state as well

Checklist

  • All tests passing
  • I have added tests to cover my changes
  • I have updated documentation (if necessary)
  • My code follows the code style of this project
    (we are using black: you can pip install pre-commit,
    run pre-commit install in the pydra directory
    and black will be run automatically with each commit)

Acknowledgment

  • I acknowledge that this contribution will be available under the Apache 2 license.

@nicolocin nicolocin changed the title [docsWIP: expand core.py documentation [docs] WIP: update docstrings for core.py Jul 16, 2020
@nicolocin nicolocin changed the title [docs] WIP: update docstrings for core.py [doc] wip: update docstrings for core.py Jul 21, 2020
@nicolocin nicolocin requested a review from djarecka July 21, 2020 04:36
@nicolocin nicolocin force-pushed the docs_core branch 2 times, most recently from e3df575 to 40ea9c3 Compare July 23, 2020 10:01
:class:`Workflow` instances inherit.

TODO: Which functions ares in Tasbase that are not overwritten in subclasses
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this might depends on the specific class. Can't be generalized 

pydra/engine/core.py Outdated Show resolved Hide resolved
pydra/engine/core.py Outdated Show resolved Hide resolved
pydra/engine/core.py Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 7, 2020

Codecov Report

Merging #317 (10a43a1) into master (312cce5) will decrease coverage by 0.02%.
The diff coverage is 93.75%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #317      +/-   ##
==========================================
- Coverage   82.57%   82.54%   -0.03%     
==========================================
  Files          20       20              
  Lines        3880     3891      +11     
  Branches     1059     1059              
==========================================
+ Hits         3204     3212       +8     
- Misses        484      487       +3     
  Partials      192      192              
Flag Coverage Δ
unittests 82.47% <93.75%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pydra/engine/core.py 88.45% <93.75%> (+0.21%) ⬆️
pydra/engine/helpers.py 78.69% <0.00%> (-0.76%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 312cce5...10a43a1. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants