-
Notifications
You must be signed in to change notification settings - Fork 917
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 Editorial Style Guide: DRep vs dRep #1325
Conversation
katomm
commented
Sep 23, 2024
•
edited
Loading
edited
- Add suggestion and reasoning for writing DRep vs dRep
- Add "hard fork" (two words)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree with the change & the rationale. I think @Ryun1 who does a lot of writing & standardisation in this area will also be happy with it & we can note to watch related CIPs for conformation to this suggestion.
Add "hard fork" (two words) based on comments on X |
Co-authored-by: Robert Phair <rphair@cosd.com>
I'm summoning @Hornan7 and @Crypto2099 to add to this discussion. |
In my opinion, there are two perspectives on capitalization in this context. From a codification standpoint, using However, in documentation, CIPs, or other user-facing materials, it makes more sense to capitalize "Delegated Representative" as "DRep." This distinction enhances clarity and formality, making it easier for readers to understand the context without being constrained by machine-readable formats. Overall, this approach ensures both technical accuracy in code and effective communication in documentation. |
I believe you have planted yourself firmly in the middle of the dreaded Now, what you (and my esteemed colleague Mr. Hornan) seem to be arguing in favor of is PascalCase. Which is named after Pascal, who was a famous mathematician but also a programming language. These two facts alone give strong weight to the argument in favor of PascalCase and canonizing the term However! The alternative is the much beloved and more frequently used in "modern day" programming: camelCase. As Mr. Hornan agrees, this is seen prolifically throughout the Cardano ecosystem in the naming of parameters and the ledger specification itself!
But wait, there's more! Given that I rest my case. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM