-
Notifications
You must be signed in to change notification settings - Fork 45
Description
Is your feature request related to a problem? Please describe.
I would like to improve the wording of the README, for example:
- Line 30: how use -> how to use
- Line 34: started to create microservice -> started creating a microservice
- Line 45: can`t -> can't
- Line 98: This initialization inject -> This initialization injects
- Line 99: like typical -> like a typical
- Line 103: Initialize Flask instance -> Initialize a Flask instance
- Line 109: return the flask instance and you can interact with it -> returns the flask instance, which you can interact with
- Line 116: This command use -> This command uses
- Line 146: finish to introduce -> finish introducing
I also see some warnings about not following Markdown convention rules, i'm using VSCode with the Markdownlint extension, which displays the following formatting warnings:
Note: they are convention warnings, sometimes you do want a specific formatting and it's okay to not follow these rules
They were also a lot of MD009/no-trailing-spaces: Trailing spaces [Expected: 0 or 2; Actual: 1], which is a common issue if trailing whitespaces are not trimmed before commiting. In Markdown, two trailing whitespaces make a newline (useful to separate paragraphs). I also would like to fix these.
If you don't want to separate paragraphs with the spaces method, i highly recomment turning on Trim Trailing Whitespace which is available in all of the common text editors/IDEs, (for example the setting is called files.trimTrailingWhitespace in VSCode and trim_trailing_white_space_on_save on Sublime)
Describe the solution you'd like
I would like to sumbit a PR to improve the wording and fix the trailing whitespaces. I would optionally fix some or all of the Markdown convention warnings, if you want to.
Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
Additional context
Add any other context or screenshots about the feature request here.
