search

elm-community / string-extra

String helper functions for Elm.
http://package.elm-lang.org/packages/elm-community/string-extra/latest
BSD 3-Clause "New" or "Revised" License
34 stars 26 forks source link

Documentation: Correct spelling, grammar, and minor errors. #16

Closed ybakos closed 7 years ago

ybakos commented 7 years ago

Use the imperative voice, similar to elm-lang core documentation. Add periods to end of sentences, and colons to ends of phrases preceding example code. Correct minor errata and misspellings in function descriptions.

Signed-off-by: Yong Bakos ybakos@humanoriented.com

ybakos commented 7 years ago

@lorenzo What do you think about this one?

jaapz commented 7 years ago

I like the changes in language as they are more consistent with Elm's documentation. But I'm not so sure about not explicitly noting Int, String and Float and instead using "integer", "string" and "float-point" (which should probably be "floating point"). I like the explicitness of actually mentioning the type.

Also I'm not sure "downcasing" is a word :P

ybakos commented 7 years ago

@jaapz Ah, I made a mistake there with "float-point". I'll fix that and re-send.

Thank you for reviewing!

As for using integer instead of Int, I agree with you but note that the core documentation does something similar, and String.Extra itself always uses string instead of String throughout. Lastly, while the verb lowercase is more correct, the verb downcase is commonly used in programming jargon.

jaapz commented 7 years ago

Ah, if that's also consistent with the elm docs then I'm fine with that. I also can't think of a better word than Downcase so let's just go with that :)

Why did you close this though? You can just update this PR :)

ybakos commented 7 years ago

@jaapz Thank you for the tip re updating the PR; I wasn't sure if @elm-community would prefer additional commits or a separate PR with changes already squashed. See https://github.com/elm-community/string-extra/pull/17