Skip to content
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

misc. lintpickens #87

Merged
merged 3 commits into from
Aug 27, 2021
Merged

Conversation

sulrich
Copy link
Contributor

@sulrich sulrich commented Aug 25, 2021

  • updates the markdownlint rules to flex on a few items. notably the following:

    • inline-html elements which are used for MkDocs stuff
    • line length for tables
  • resolves a grip of linting issues inclusive of the relaxed linting rules for various elements.

  • typos in the contribution guide

    a couple of comments here:

    • in some cases, there were very large (unreadable anyway) code blocks that were exceeding the line-length rules. i wrapped with wild abandon.
    • in other cases, there were long CLI examples that I reformatted to use \ continuation indicators as appropriate. in some cases this may not have been appropriate in which case, I added text explaining to the reader that the continuation marks were there for readability and they will need to modify this prior to using these in their configs. which seemed fine given that these were for involved command-line flags which need to be edited anyway.

@sulrich sulrich marked this pull request as draft August 27, 2021 00:03
@sulrich sulrich marked this pull request as ready for review August 27, 2021 00:03
Copy link
Contributor

@fredhsu fredhsu left a comment

Choose a reason for hiding this comment

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

lgtm

@sulrich sulrich merged commit c7c0b9e into aristanetworks:main Aug 27, 2021
@sulrich sulrich deleted the sulrich-lintpickin-20210824 branch January 25, 2022 02:30
@sulrich sulrich restored the sulrich-lintpickin-20210824 branch January 25, 2022 02:33
@sulrich sulrich deleted the sulrich-lintpickin-20210824 branch January 25, 2022 02:35
@sulrich sulrich restored the sulrich-lintpickin-20210824 branch January 25, 2022 02:52
@sulrich sulrich deleted the sulrich-lintpickin-20210824 branch January 25, 2022 02:53
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.

None yet

2 participants