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

Update comments for custom rules as requested by reviewer #29018

Merged
merged 4 commits into from
Nov 2, 2024

Conversation

akhilmohnn
Copy link
Contributor

@akhilmohnn akhilmohnn commented Oct 28, 2024

Because

This PR

Issue

Related to #29012

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

@MaoShizhong
Copy link
Contributor

Carryover from #29012

You don't need to open new PRs for every change requested. PRs just track a branch so you only need to commit and push any changes to your customRuleComments branch and the PR will automatically update.

Since you've opened this PR already I'll use this one and close the old one.

Copy link
Contributor

@MaoShizhong MaoShizhong left a comment

Choose a reason for hiding this comment

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

Could you fix the indentation of the new comments please? They're both indented by 2 spaces too many.

You don't need to make a new PR, just push the changes to this branch.

@akhilmohnn
Copy link
Contributor Author

Thank you for your feedback! I’ll go ahead and fix the indentation of the comments as requested. Once I’ve made the changes, I’ll push the updates to this branch.

Comment on lines 82 to 84
},
// Custom rules specific to the project
// Docs for each rule can be found in `./markdownlint/docs`
Copy link
Contributor

Choose a reason for hiding this comment

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

I meant that the comments were indented too much, not that the closing brace wasn't indented enough.

Suggested change
},
// Custom rules specific to the project
// Docs for each rule can be found in `./markdownlint/docs`
},
// Custom rules specific to the project
// Docs for each rule can be found in `./markdownlint/docs`

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've now updated the comments in the .markdownlint-cli2.jsonc file as requested. Just to clarify, my previous comments were aligned with the formatting of the other comments in the file, correct? Please let me know if there’s anything else that needs adjustment. Thank you!

.markdownlint-cli2.jsonc Outdated Show resolved Hide resolved
@MaoShizhong MaoShizhong merged commit 3915947 into TheOdinProject:main Nov 2, 2024
1 check passed
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.

2 participants