Skip to content

Fix linting issues with markdown files#1514

Merged
abhishekkumams merged 2 commits intomainfrom
dev/abhishekkuma/fix_md_lint_issue
May 26, 2023
Merged

Fix linting issues with markdown files#1514
abhishekkumams merged 2 commits intomainfrom
dev/abhishekkuma/fix_md_lint_issue

Conversation

@abhishekkumams
Copy link
Copy Markdown
Contributor

Why make this change?

  • fixing lint issues to improve code readability and maintainability. It also reduces the likelihood of bugs and errors, and make it easier to collaborate with others on your code.

What is this change?

  • Fixing lint errors such as
    • No bare url, as those URL's aren't converted into a link in many markdown parsers.
    • Missing or inconsistent heading levels.
    • Missing empty line at the end of the file.

@abhishekkumams abhishekkumams changed the title Fixing linting issues with markdown files Fix linting issues with markdown files May 24, 2023
Copy link
Copy Markdown
Contributor

@seantleonard seantleonard left a comment

Choose a reason for hiding this comment

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

thanks for updating!

Copy link
Copy Markdown
Collaborator

@Aniruddh25 Aniruddh25 left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you for keeping our documentation clean!!

@abhishekkumams abhishekkumams merged commit edbaec1 into main May 26, 2023
@abhishekkumams abhishekkumams deleted the dev/abhishekkuma/fix_md_lint_issue branch May 26, 2023 03:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants