Restructure comments.md with suggested format (#79) #277
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the comments.md guide by introducing a clearer section layout and adding practical usage examples to improve readability.
- Added a Types of Comments section with distinct Single-line and Multi-line subsections
- Inserted a new Real-life Examples of Comments section showcasing DOM manipulation and debugging scenarios
- Refined paragraph breaks and formatting for better flow and clarity
Comments suppressed due to low confidence (3)
en/basics/comments.md:13
- [nitpick] Heading style is inconsistent: use hyphens in both section titles. Change
### Single Line Commentsto### Single-line Commentsto match### Multi-line Comments.
### Single Line Comments
en/basics/comments.md:11
- [nitpick] After this heading, consider adding a brief introductory sentence (e.g., "In JavaScript, comments can be written in two ways: single-line and multi-line.") to guide readers into the subsections.
## Types of Comments
en/basics/comments.md:49
- [nitpick] The two adjacent code fences for the disabled welcome message could be merged into one block to keep the explanatory comment and the commented-out code together, improving readability.
```javascript
|
Closes #79 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request addresses issue #79 by restructuring the
comments.mdfile in the English content directory.Changes made:
## Types of Commentswith### Single Lineand### Multi Linesubsections.## Real life examples of commentswith sample DOM manipulation code.Let me know if any adjustments are needed. Happy to iterate!
Closes #79