8000 Improve README wording and fix trailing whitespaces · Issue #172 · python-microservices/pyms · GitHub
[go: up one dir, main page]
Skip to content

Improve README wording and fix trailing whitespaces #172

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.

Sign up for GitHub

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

Jump to bottom
Closed
ibLeDy opened this issue Oct 1, 2020 · 3 comments · Fixed by #173
Closed

Improve README wording and fix trailing whitespaces #172

ibLeDy opened this issue Oct 1, 2020 · 3 comments · Fixed by #173
Assignees
@ibLeDy
Labels
bug Something isn't working documentation Features and bugs of documentation good first issue Good for newcomers Hacktoberfest

Comments

@ibLeDy
Copy link
Contributor
ibLeDy commented Oct 1, 2020

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:

2020-10-01_10-57-03

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.
@avara1986 avara1986 added bug Something isn't working documentation Features and bugs of documentation good first issue Good for newcomers Hacktoberfest labels Oct 1, 2020
@avara1986
Copy link
Member

awesome issue @ibLeDy ! ❤️
Submit a PR if you like! Thanks a lot for the explanation 😍

@ibLeDy
Copy link
Contributor Author
ibLeDy commented Oct 1, 2020

Thanks!

Do you want me to fix the Markdown ones too?

If the answer is yes, the MD026 (L96) may be the only one that you may want to keep as it is, so unless you specify that you want it fixed too, i will omit that one.

@avara1986
Copy link
Member

Hi, could be perfect to fix the Markdown too 😄

About MD026 (L96), it is a bug, the L96 must be a H2, not a H3

ibLeDy added a commit to ibLeDy/pyms that referenced this issue Oct 1, 2020
@ibLeDy
Improve wording in README
e1aa18b 
Fixes python-microservices#172
@ibLeDy ibLeDy mentioned this issue Oct 1, 2020
Merged
avara1986 pushed a commit that referenced this issue Oct 1, 2020
@ibLeDy
Fix/improve README wording and formatting. (#173)
73b5436 
* Fix trailing whitespace in README

* Improve wording in README

Fixes #172

* Fix Markdownlint's warnings in README

L12: MD012/no-multiple-blanks
L58: MD025/single-title/single-h1
L96: MD001/heading-increment/header-increment
L148: MD022/blanks-around-headings/blanks-around-headers
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ibLeDy ibLeDy

Labels
bug Something isn't working documentation Features and bugs of documentation good first issue Good for newcomers Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix/improve README wording and formatting. ibLeDy/pyms
2 participants
@avara1986 @ibLeDy
0