Skip to content

docs: update readme style #471

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

Merged
merged 1 commit into from
Feb 22, 2020

Conversation

miketheman
Copy link
Contributor

Using MarkdownLint in VSCode, this file was showing many linter errors,
mostly around whitespace issues, but a few others that made it annoying
enough when looking at the file, it was inconsistent and difficult to
read.

Also handles a few existing notes about caching.

Refs #412
Resolves #420
Resolves #424

Signed-off-by: Mike Fiedler [email protected]

Using MarkdownLint in VSCode, this file was showing many linter errors,
mostly around whitespace issues, but a few others that made it annoying
enough when looking at the file, it was inconsistent and difficult to
read.

Also handles a few existing notes about caching.

Refs serverless#412
Resolves serverless#420
Resolves serverless#424

Signed-off-by: Mike Fiedler <[email protected]>
Copy link
Contributor

@bsamuel-ui bsamuel-ui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've used prettier to lint markdown in other projects, should we do that?

@bsamuel-ui bsamuel-ui merged commit f334de7 into serverless:master Feb 22, 2020
@miketheman miketheman deleted the miketheman/update-readme branch February 22, 2020 16:37
@miketheman
Copy link
Contributor Author

I've used prettier to lint markdown in other projects, should we do that?

ooh, good call! I can add that to the Lint scope and test.

miketheman added a commit to miketheman/serverless-python-requirements that referenced this pull request Feb 22, 2020
Updates commands to catch when Markdown is malformed.

Refs: serverless#471 (review)

Signed-off-by: Mike Fiedler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Misleading README instructions about using caches
2 participants