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

Docs update #76

Merged
merged 36 commits into from Aug 28, 2017

Conversation

3 participants
@tiagofilipe12
Member

tiagofilipe12 commented Aug 23, 2017

This PR intends to improve current bionode-watermill documentation.

@tiagofilipe12 tiagofilipe12 self-assigned this Aug 23, 2017

@tiagofilipe12 tiagofilipe12 requested a review from thejmazz Aug 23, 2017

@codecov-io

This comment has been minimized.

codecov-io commented Aug 23, 2017

Codecov Report

Merging #76 into dev will decrease coverage by 0.17%.
The diff coverage is 66.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev      #76      +/-   ##
==========================================
- Coverage   82.27%   82.09%   -0.18%     
==========================================
  Files          37       37              
  Lines         897      905       +8     
  Branches      108      110       +2     
==========================================
+ Hits          738      743       +5     
- Misses        159      162       +3
Impacted Files Coverage Δ
lib/reducers/collection.js 87.77% <100%> (ø) ⬆️
lib/lifecycle/resolve-input.js 72.05% <62.5%> (-1.28%) ⬇️

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 2a68747...4593a4c. Read the comment docs.

@bmpvieira bmpvieira added this to In Progress in Bionode Project Board Aug 24, 2017

@tiagofilipe12

This comment has been minimized.

Member

tiagofilipe12 commented Aug 25, 2017

So, I think I have covered all the topics that we discussed regarding the docs. Just have that example with the multiple-inputs in the two-mappers pipeline that maybe can be removed from this PR. What do you think about it @thejmazz ? I made a disclaimer on the script anyway...
Otherwise if you agree with the modifications feel free to merge.

@tiagofilipe12

This comment has been minimized.

Member

tiagofilipe12 commented Aug 25, 2017

Hmm just noticed that docs/Task.md still needs a little simplifcation.

tiagofilipe12 added some commits Aug 25, 2017

>```
> This will end up in three different branches (or lineages) with three
>leaves:
> `task0 --> task1 --> task4`, `task0 --> task2 --> task4` and `task0 -->

This comment has been minimized.

@thejmazz

thejmazz Aug 25, 2017

Member

name these forked tasks task2A, task2B, task2C

(to be consistent with idea that fork is for multiple "alternatives" to a specific task (e.g. different params)
rather than different tasks

This comment has been minimized.

@tiagofilipe12
join(task2, task3, fork(task4, task5))
),
task6
)

This comment has been minimized.

@thejmazz

thejmazz Aug 25, 2017

Member

add labeled diagram (not the d3 screenshot) for this pipeline

@thejmazz thejmazz merged commit 398dd75 into dev Aug 28, 2017

3 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
security/snyk No new vulnerabilities
Details

@bmpvieira bmpvieira moved this from In Progress to Done in Bionode Project Board Aug 28, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment