Docs/Improve documentation

[yarkhinephyo]

Summary

Issue #28

• Fix spellings
• Fix docstrings
  • Example: Missing callable in columns : str or iterable, optional
• Add code examples when use cases are complex
  • Trying to use existing tests when possible
  • If cannot, tests are added
• Enable links for crucial references
  • Example: pdpipe.cq to pdpipe.cq

Progress

• documentation.md
• pdpipe.basic_stages
• pdpipe.col_generation
• pdpipe.cond
• pdpipe.core
• pdpipe.cq
• pdpipe.nltk_stages
• pdpipe.skintegrate
• pdpipe.sklearn_stages
• pdpipe.text_stages
• pdpipe.wrappers

[codecov]

Codecov Report

Merging #65 (957276b) into master (f14581d) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 957276b differs from pull request most recent head e57988e. Consider uploading reports for the commit e57988e to get more accurate results

@@            Coverage Diff            @@
##            master       #65   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           14        14           
  Lines         2033      2033           
  Branches       271       271           
=========================================
  Hits          2033      2033           

Impacted Files	Coverage Δ
pdpipe/col_generation.py	100.00% <ø> (ø)
pdpipe/core.py	100.00% <ø> (ø)
pdpipe/cq.py	100.00% <ø> (ø)
pdpipe/skintegrate.py	100.00% <ø> (ø)
pdpipe/text_stages.py	100.00% <ø> (ø)
pdpipe/wrappers.py	100.00% <ø> (ø)
pdpipe/basic_stages.py	100.00% <100.00%> (ø)
pdpipe/cond.py	100.00% <100.00%> (ø)
pdpipe/nltk_stages.py	100.00% <100.00%> (ø)
pdpipe/sklearn_stages.py	100.00% <100.00%> (ø)
... and 2 more

---

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 f14581d...e57988e. Read the comment docs.

[yarkhinephyo]

Hi @shaypal5

• pdpipe.util.per_column_valus_sklearn_transform function seems to have spelling mistake. Should I make an issue?
• exclude_columns in ColumnsBasedPipelineStage does not work with pdpipe.cq even though the documentation mentions consistently that it works. There are no relevant tests for cq + exclude_columns too so it should not be implemented yet. Is it a work in progress or is there a mistake in the documentation?

[shaypal5]

Looks very good so far! Great work. :)

Regarding your points:

1. Just fix them :)
2. Yeah, I know about this and I'll get to this soon (see issue Have column-based stages successfully support column qualifiers as arguments #58). You can add tests that should work and mark them with @pytest.mark.xfail - I already have one testing this and failing.

[shaypal5]

Let me know when you're finished, and remember - you must rebase all commits to a single one when you're done and want me to merge this.

[yarkhinephyo]

Oh there are two spelling issues in main page. I cannot locate in the repository.

[shaypal5]

Nice catch. I'll get them. They're on a different branch.
Let me know when you're done. :)

[yarkhinephyo]

@shaypal5 The PR is ready and I have squashed the commits into a single commit :)

[shaypal5]

Amazing work! So meticulous. Thank you for such a great contribution. :)

[shaypal5]

A small request: Next time, please run flake8 before submitting the PR. You had 48 flake8 errors. You should probably have your IDE (whatever you use) configured so it output flake8-compliant files.

You had missing newlines at the end of a file, and a lot of trailing whitespaces at the end of lines. These are things that should automatically be handled by any proper IDE.