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

chore(docs): lists should be surrounded by blank lines in md #2209

Merged
merged 1 commit into from
Aug 4, 2023

Conversation

rach-id
Copy link
Member

@rach-id rach-id commented Aug 3, 2023

Overview

Adding a new line before the list so that the linter doesn't complain.

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@rach-id rach-id added documentation Improvements or additions to documentation chore optional label for items that follow the `chore` conventional commit labels Aug 3, 2023
@rach-id rach-id self-assigned this Aug 3, 2023
@MSevey MSevey requested a review from a team August 3, 2023 17:56
@rach-id rach-id changed the title chore: lists should be surrounded by blank lines in md chore(docs): lists should be surrounded by blank lines in md Aug 3, 2023
@rootulp
Copy link
Collaborator

rootulp commented Aug 3, 2023

Is the linter complaining for you locally? I think we may need to bump the version of markdownlint that is running in CI and/or specify a version of markdownlint to install locally so that we don't run into issues like this.

The latest commit on main passes CI markdown-lint: https://github.com/celestiaorg/celestia-app/actions/runs/5751200172/job/15589466922

@rach-id
Copy link
Member Author

rach-id commented Aug 3, 2023

Is the linter complaining for you locally?

Yes, which was weird. But since the change is also idiomatic, the lists should be surrounded by blank lines, I opened a PR

Copy link
Member

@evan-forbes evan-forbes left a comment

Choose a reason for hiding this comment

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

does this not get linted?

@rach-id
Copy link
Member Author

rach-id commented Aug 4, 2023

for some reason it's not failing because of that, I opened an issue to track this: #2212

@rach-id rach-id merged commit 70b0624 into celestiaorg:main Aug 4, 2023
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore optional label for items that follow the `chore` conventional commit documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants