isocpp / isocpp/CppCoreGuidelines
Adjust the synopsis of rule Enum.1
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 45.3k
- Forks
- 5.6k
- PR merge metrics
- No merged PRs in 30d
Description
Now that other alternatives than enums are allowed for rule Enum.1 (see ticket #2054), the synopsis of the rule should be changed accordingly. It should be something like "Prefer enumerations or constants over macros".
Contributor guide
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
Locate the Enum.1 rule entry in the guidelines and compare its current synopsis with the change described in ticket #2054. Update the synopsis to reflect that alternatives to enums are allowed, using the proposed wording as a guide; done means the rule accurately mentions enumerations or constants and macros.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100