lowRISC / lowRISC/style-guides
Parameter naming convention inconsistencies
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 542
- Forks
- 132
- PR merge metrics
- No merged PRs in 30d
Description
The naming convention specifies module parameters should use the UpperCamelCase style:
But several examples in the guide inconsistently use the styling for constants:
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open VerilogCodingStyle.md at the linked sections around lines 656 and 992 and compare the constant examples with the stated module-parameter naming convention. Update the inconsistent examples so the guide applies one naming style consistently, then review both referenced sections for remaining mismatches.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100