thautwarm / MLStyle.jl

Julia functional programming infrastructures and metaprogramming facilities
https://thautwarm.github.io/MLStyle.jl/latest/
MIT License
404 stars 39 forks source link

Some Docs suggestions #114

Closed caseykneale closed 3 years ago

caseykneale commented 3 years ago

Hi I am a Julia programmer who recently started learning functional programming. I think your package is really cool! I made some changes to the documentation. You do not have to accept them, but they, improve some of the grammar.

I feel your original documentation was good, but others may struggle to read some small parts in it.

codecov[bot] commented 3 years ago

Codecov Report

Merging #114 (866e3bf) into master (6084bf7) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #114   +/-   ##
=======================================
  Coverage   88.73%   88.73%           
=======================================
  Files          28       28           
  Lines        1563     1563           
=======================================
  Hits         1387     1387           
  Misses        176      176           

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 6084bf7...866e3bf. Read the comment docs.

thautwarm commented 3 years ago

Thanks. I'm not a native English speaker, and as your PR is a bit large, I'd ask others to help me with review.

thautwarm commented 3 years ago

@MasonProtter Hi Mason, could you help here?

caseykneale commented 3 years ago

That is a good idea. I am a native English speaker, but, my English isn't always the best :)

caseykneale commented 3 years ago

No problem I had some free time come up and thought I'd put it to use.

I agree with pretty much all of your knit-picks.

thautwarm commented 3 years ago

Bigs thanks to @caseykneale and @MasonProtter ! Once Mason approve the PR I will merge it.

caseykneale commented 3 years ago

I am not in a hurry, just wanted to help :). Let me know if there's anything else I can do,

thautwarm commented 3 years ago

There are 29 commits, do you mind if I squash them? @caseykneale

MasonProtter commented 3 years ago

I think maybe this should be reverted and squashed. That was a LOT of commits

thautwarm commented 3 years ago

I didn't operate it correctly, maybe you make a PR again?