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

cat_pool specs markdown issues #2227

Closed
rootulp opened this issue Aug 8, 2023 · 0 comments · Fixed by #2242
Closed

cat_pool specs markdown issues #2227

rootulp opened this issue Aug 8, 2023 · 0 comments · Fixed by #2242
Labels
good first issue Good for newcomers

Comments

@rootulp
Copy link
Collaborator

rootulp commented Aug 8, 2023

Context

#2207 just merged. It passes markdownlint on CI but fails for me locally. I have markdownlint 0.35.0 installed locally.

Problem

$ make lint
--> Running golangci-lint
--> Running markdownlint
specs/src/specs/cat_pool.md:6 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
specs/src/specs/cat_pool.md:90:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
specs/src/specs/cat_pool.md:91:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
specs/src/specs/cat_pool.md:102 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
make: *** [lint] Error 1

Proposal

  1. Fix the markdowlint errors above
  2. Markdown lint CI not failing on non-respected rules #2212
@rootulp rootulp added good first issue Good for newcomers linter labels Aug 8, 2023
staheri14 added a commit that referenced this issue Aug 10, 2023
…#2242)

## Overview
Closes #2227 

## Checklist
- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [x] Linked issues closed with keywords
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant