Docs: Improved style, grammar and formatting. #31
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FesonX
suggested changes
Dec 15, 2020
README.md
Outdated
| Flask-State is a lightweight chart plugin for displaying machine state data in your web application. | ||
|
|
||
| Flask-State is an active project, well-tested and complete update roadmap. | ||
| * **Monitored Data:** CPU, memory, disk usage, LoadAVG and boot time. |
There was a problem hiding this comment.
Maybe Monitored Metric is better
README.md
Outdated
| We're on [Gitter](https://gitter.im/flaskstate/community) ! Please join us. | ||
|
|
||
| We're on [Gitter](https://gitter.im/flaskstate/community)! Join the conversation | ||
| fore more questions and inquiries about this project. |
There was a problem hiding this comment.
Correct: fore -> for more questions and inquiries about this project.
There was a problem hiding this comment.
Thanks for your suggestions, I'm on it!
|
I don't know Mandarin so it would be great if someone could also edit this file to reflect the changes made in this PR. In some instances I used shorter and more concise language, take for example - ### Secondly：Call the init_app method of the flask-state to initialize the configuration.
+ ### 2. Configure Flask-StateIn this specific case it was obvious from the subsequent code snippet that the import flask_state
flask_state.init_app(app) |
|
Hi @hentai-chan. Thanks for your the suggestions ! |
PindleskinY
pushed a commit
that referenced
this pull request
Jan 11, 2021
* Docs: Improved style, grammar and formatting. * Docs: Add changes suggested by FesonX
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I tried to improve the English translation while staying true to the original document. I also changed the formatting a little so that this README file conforms to markdown rules and recommendations.