crybapp / api

Core service used to handle events from clients
MIT License
36 stars 8 forks source link

Fix missing full stop. #91

Closed MicroDroid closed 4 years ago

JeDaYoshi commented 4 years ago

nice PR

darnfish commented 4 years ago

There isn't supposed to be a full stop and the end of categories before a header. Reverting...

JeDaYoshi commented 4 years ago

you know you didn't PR it right

MicroDroid commented 4 years ago

@neoncloth

A full stop should be used whenever there is a concrete sentence. For example in lists, if you have a list as such:

You see here we did not use a full stop since it isn't a concrete sentence. However, in this other list we would use a full stop:

Given that the note contains a concrete sentence, a full stop should be used. You see I used "should" because eventually it's all about consistency and stylistic choices, however, since the README does use full stops properly, it makes sense for the note as well to have a full stop.

Thus, this PR is a more correct version of the README. Here you can get more information about the subject.

Thanks.