Updated docstrings

[ceferisbarov]

Updated docstrings for:

• Rename
• Replace
• Coalesce
• Coerce
• Identity

[codecov-commenter]

Codecov Report

Merging #48 (25d27d0) into master (edd4c24) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 25d27d0 differs from pull request most recent head 7c32d8d. Consider uploading reports for the commit 7c32d8d to get more accurate results

@@            Coverage Diff             @@
##           master      #48      +/-   ##
==========================================
- Coverage   92.85%   92.84%   -0.02%     
==========================================
  Files          19       19              
  Lines         462      461       -1     
==========================================
- Hits          429      428       -1     
  Misses         33       33              

Impacted Files	Coverage Δ
src/transforms/coalesce.jl	100.00% <ø> (ø)
src/transforms/coerce.jl	93.33% <ø> (ø)
src/transforms/identity.jl	75.00% <ø> (ø)
src/transforms/rename.jl	100.00% <ø> (ø)
src/transforms/replace.jl	100.00% <ø> (ø)
src/colspec.jl	100.00% <0.00%> (ø)
src/transforms/filter.jl	98.00% <0.00%> (ø)
src/transforms/select.jl	91.30% <0.00%> (ø)

---

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 edd4c24...7c32d8d. Read the comment docs.

[juliohm]

Good catch @eliascarv , I think we should omit it. Advanced users can always read the source. Agree?

[eliascarv]

T = Rename(Dict(:a => :x, :c => :y))

@juliohm, I think the Rename(dict) method is part of the internal API, should we expose this to the user?

[juliohm]

I was thinking that maybe we should erase the T = ... in front of every example. It doesn't help to name a variable in this context. Can you remove all occurrences of T in the docstrings @ceferisbarov ? Feel free to request a new review when the PR is ready for review again.

[eliascarv]

I agree, I will remove from the docstrings I made in the next PR.

[ceferisbarov]

So do we completely remove the docstring for Rename, or should we still leave some sort of comment explaining its behavior?

@juliohm @eliascarv

[juliohm]

I don't understand your question @ceferisbarov , why would we remove the docstring of Rename?

[juliohm]

I did the commits myself because apparently some of my previous suggestions were ignored. I removed all ## Notes sections because they were not helpful. You add a note to a docstring when it adds new information that the user may not be aware ahead of time. For example, saying that the Identity transform preserves the schema is not very useful. Everyone knows that already and will just spend more time reading the docstring ## Notes.

[ceferisbarov]

@juliohm I hadn't ignored the suggestions. I was going to make those changes in my computer and commit. Sorry for the confusion.