search

DusanKasan / Knapsack

Collection pipeline library for PHP
http://dusankasan.github.io/Knapsack/
MIT License
535 stars 56 forks source link

Cleanup and fix the docs #34

Closed jdreesen closed 7 years ago

jdreesen commented 7 years ago

I went through the docs/docblocks and fixed some typos and inconsistencies.

jdreesen commented 7 years ago

I am also thinking of changing all the array|Traversable into iterable in documentation (can't do it in code yet, don't want to drop support for 5.6) so you can also include that in this PR if you would like to do that, seeing as you are already refactoring those parts.

Do you mean that array|Traversable should be replaced by iterable in the doc blocks or in the README or both?

jdreesen commented 7 years ago

I replaced it everywhere in the docs in a separate commit.

DusanKasan commented 7 years ago

Sorry, i did not make myself clear. I meant to use iterable just in the readme. We can't use it in phpdoc yet, before we move to 7.1. The reasoning behind this is that phpdoc is part of the code, whereas readme isn't.

Otherwise everything looks good. Can you fix this (revert phpdocs to use array|[]Traversable) small issue please?

jdreesen commented 7 years ago

Sure, I reverted the iterable type hints to array|Traversable in the phpdocs and squashed the commits.

DusanKasan commented 7 years ago

Thank you for the contribution.

jdreesen commented 7 years ago

Thank you for this great library! :)