Skip to content

docs: fix grammatical and logical bugs in VerilogCodingStyle.md#92

Open
mondalsushant wants to merge 2 commits into
lowRISC:masterfrom
mondalsushant:fix/grammatical-and-logical-bugs
Open

docs: fix grammatical and logical bugs in VerilogCodingStyle.md#92
mondalsushant wants to merge 2 commits into
lowRISC:masterfrom
mondalsushant:fix/grammatical-and-logical-bugs

Conversation

@mondalsushant

@mondalsushant mondalsushant commented May 20, 2026

Copy link
Copy Markdown
  • Fix missing space before parenthesis in "UNIX-style line endings" rule
  • Fix "With the exceptions of" -> "With the exception of"
  • Fix period inside backtick: end. -> end.
  • Fix "Conversation" -> "Reason" in constants table header
  • Fix "symbolicly" -> "symbolically"
  • Fix "Examples;" -> "Examples:"
  • Fix "non-block" -> "non-blocking" assignments
  • Fix "recommened" -> "recommended"
  • Fix "identifed" -> "identified"
  • Fix missing closing parenthesis in good code example
  • Fix missing semicolon in code example
  • Fix "and be implemented" -> "and must be implemented"
  • Fix "deferred to case statement" -> "deferred to the case statement"
  • Fix "explanations examples" -> "explanations, examples"

@mondalsushant

Copy link
Copy Markdown
Author

Hi @rswarbrick and @marnovandermaas,

The changes are ready for inspection. Whenever you have some time, could you please take a look and review this PR?

Thank you!

@mondalsushant

Copy link
Copy Markdown
Author

@rswarbrick can you please have a look at this since I saw you are online. Thanks!

Comment thread VerilogCodingStyle.md Outdated
The preferred naming convention for all immutable constants is to use `ALL_CAPS`, but there are times when the use of `UpperCamelCase` might be considered more natural.

| Constant Type | Style Preference | Conversation |
| Constant Type | Style Preference | Convention |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I agree that "Conversation" is a slightly weird heading here, but I don't think that "Convention" is the right fix. How about "Reason" or "Justification"?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

"Reason" might be better than "Justification", right? Because "Justification" tries to "defend" something, whereas "Reason" is neutral, fits into the context, and is short too. What's your say?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Done: Went with "Reason".

Comment thread VerilogCodingStyle.md Outdated
Note: A new PR is required for "2012" -> "2017" as per the reviewer.
@mondalsushant mondalsushant force-pushed the fix/grammatical-and-logical-bugs branch from 9a6630c to 144c302 Compare July 2, 2026 13:52
@mondalsushant mondalsushant deleted the fix/grammatical-and-logical-bugs branch July 2, 2026 14:04
@mondalsushant mondalsushant restored the fix/grammatical-and-logical-bugs branch July 2, 2026 14:10
@mondalsushant mondalsushant reopened this Jul 2, 2026
@mondalsushant mondalsushant requested a review from rswarbrick July 2, 2026 14:17
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