Skip to content

Docs update#76

Merged
thejmazz merged 36 commits intodevfrom
docs_update
Aug 28, 2017
Merged

Docs update#76
thejmazz merged 36 commits intodevfrom
docs_update

Conversation

@tiagofilipe12
Copy link
Member

This PR intends to improve current bionode-watermill documentation.

@codecov-io
Copy link

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.

thejmazz
thejmazz previously approved these changes Aug 24, 2017
@tiagofilipe12
Copy link
Member Author

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
Copy link
Member Author

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

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

Choose a reason for hiding this comment

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

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

Copy link
Member Author

Choose a reason for hiding this comment

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

👍

join(task2, task3, fork(task4, task5))
),
task6
)
Copy link
Member

Choose a reason for hiding this comment

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

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

@thejmazz thejmazz merged commit 398dd75 into dev Aug 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants