more debugging clarifications and rewrites #753
Conversation
|
A preview for this pull request is available at https://cdn.rawgit.com/Spongy/SpongeDocs-PRs/8b7bd5e/. Here are some links to the pages that were modified: Since the preview frequently changes, please link to this comment, not to the direct url to the preview. |
phit
added
input wanted
| Sponge bug (or another coremod being present). | ||
| * Other classes have to be mapped to their mods by hand. In this case there is this entry | ||
| ``com.example.extendedaiplugin``, Java projects usually follow the Maven package naming standard |
There was a problem hiding this comment.
comma after com.example.extendedaiplugin should be a semicolon.
comma needed after groupId.groupId.artifactId
semicolon needed after "backwards"
comma needed after example.com
comma or hyphen needed after "name of the project" (or put "also known as artifact in the Java world" in brackets)
comma after ``extendedaiplugin` should be a semicolon
comma needed after "when in doubt"
|
|
||
| .. warning:: | ||
| Be careful when coremods are present, it can mean that although a Minecraft class was reported as the cause, it does |
There was a problem hiding this comment.
comma after "coremods are present" should be a semicolon (or end the sentence there and start a new one at "It ...").
comma needed after "it can mean that"
comma (or hyphen) needed after "Minecraft source"
Remove "Though" and start final sentence with "Be"
There was a problem hiding this comment.
i don't like commas 😆
ill fix it when i get up in the morning
There was a problem hiding this comment.
Don't go into a comma coma 😴
There was a problem hiding this comment.
I'm not sure (because the headlines are not real headlines), but headlines should use Title Case.
Java projects usually follow the Maven package naming standard
I'm not sure that this is correct, but using the web search is a good hint/alternative.
All in all its a good improvement.
|
I missed the headlines/titles bit, they used to be more like bullet points. They are all sentences anyway. We might let this slide, or we could revert them to "(1) blah" style (note parentheses) or just individual bullets. |
|
I feel like the page looked really odd before with how the checklist was presented, if we don't make them small headings I would like to at least make them bold. |
|
Please resolve merge conflicts. |
Inscrutable
removed
the
needs review
adds to #745