-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
172 improve documentation add readme files #173
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apply first comment in all files.
- don't put filler stuff, why mentioning for example
**return type:**
`void`
(which is also invalid, because 1) there is no return type; 2) there is no void
type)
- fix formatting, put plain text as plain text and code as code
e734e96
to
74ea4f9
Compare
74ea4f9
to
53f70a3
Compare
@gangov Please see the changes I introduced in the last commit and apply them to other readmes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Great effort. Seems like a pain in the back, but you'll see that it will ease a lot of work in the future for new people.
No description provided.