Clarify and fix grammar for Formats docs #867
Conversation
…pend... ' sentence doesn't relate to them)
…ackage' is confusing and ambiguous to new users)
…Helps to relate to the 'Output' section below)
…ro paragraph a bit more
…umentation hasn't referred to 'mapping key')
… optional comma and colon
…e'. "pattern" makes it clear that the example can be generalized
…gh from the preceding ones.
…efers to a thing (an event/task that happens)
…tter and show example results
…ow this is different ("....content..." can easily be overlooked at first glance)
…les ("First we...." doesn't make sense when the code is so simple.)
…than text within a paragraph.
|
Hi @weedySeaDragon, Thank you for your contribution! We really value the time you've taken to put this together. Before we proceed with reviewing this pull request, please sign the Typesafe Contributors License Agreement: |
|
😮 Wow. Thanks a lot. How long did it take to fix my english? Did you use a tool or was it plain old reading and fixing? Squashing is not necessary. Github now supports this in the UI ;) |
|
Just plain old (slightly compulsive) editing. Writing the comments for the commits is what took a while. ;-) It wasn't that much, really. There's some really great info in there! I'm trying to note some ideas for doing a little re-organizing to highlight some of it. (For example: There's a great explanation of mappings in there. I think it'd be powerful & much more helpful if that explanation was in the Intro: Main Concepts section.) That's for another time. I'm happy to help. It's a great way for me to learn this! |
|
|
||
| .. code-block:: scala | ||
|
|
||
| libraryDependencies += "org.vafer" % "jdeb" % "1.3" artifacts (Artifact("jdeb", "jar", "jar")) | ||
|
|
||
| JDeb is a provided dependency so you have to add it on your own. It brings a lot of dependencies | ||
| JDeb is a provided dependency. (It is not a not an AutoPlugin_.) You have to explicitly add it on your own. It brings a lot of dependencies |
There was a problem hiding this comment.
"It is not a not an AutoPlugin._" ? I think you can remove that :)
There was a problem hiding this comment.
Will do. (I think that shows my personal learning curve. :-) )
|
So a few small notes. Beside that: Amazing work :) |
|
Will make those changes in a bit. Thanks for reviewing it so quickly! |
|
Awesome :) You made it easy to review ;) |
Like I did with PR #863 , I went through the docs in the Formats section and corrected grammar, fixed typos, and did a little clarifying and strengthening. Like #863, I didn't squash the commits in case someone wanted to review them. (But I can squash.)