-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Remove unnecessary words and organize content in keras.md #2311
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
Conversation
Improvements to the clarity and structure of the documentation. Metrics include: - 30% fewer words. - The tone shifts more neutral by 9% - No significant difference in Flesch-Kincaid readability scores.
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.
Please don't use "add file"/"update file"/"fix file"/etc. commit messages. These are hard to reason about when looking at the history of the file/repository. Instead, please write explanatory git commit messages.
Overall, this looks good to me. Thank you
The commit message is also the title of the PR if the PR has only one commit. It is thus twice important to have commit messages that are relevant, as PRs would be easier to understand and easier to analyze in search results.
For how to write good quality git commit messages, please consult https://cbea.ms/git-commit/
Thanks for the advice @mihaimaruseac ! I have bookmarked that commit message resource and updated the subject of the pull request.
Is there anything I need to do to make progress toward either getting this pull request approved or denied?
Improvements to the clarity and structure of the documentation. Metrics include: