Skip to content
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

Merged
merged 3 commits into from
Sep 30, 2024

Conversation

katomm
Copy link
Member

@katomm katomm commented Sep 23, 2024

  • Add suggestion and reasoning for writing DRep vs dRep
  • Add "hard fork" (two words)

Copy link
Collaborator

@rphair rphair left a 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.

docs/portal-style-guide.md Outdated Show resolved Hide resolved
@katomm
Copy link
Member Author

katomm commented Sep 24, 2024

Add "hard fork" (two words) based on comments on X

Co-authored-by: Robert Phair <rphair@cosd.com>
@katomm
Copy link
Member Author

katomm commented Sep 25, 2024

I'm summoning @Hornan7 and @Crypto2099 to add to this discussion.

@Hornan7
Copy link

Hornan7 commented Sep 25, 2024

In my opinion, there are two perspectives on capitalization in this context. From a codification standpoint, using dRep is common because certain identifiers must start with a lowercase letter, especially in programming environments where this is a requirement.ex : dRepVotingThreshold,dRepActivity etc.

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.

@Crypto2099
Copy link

Crypto2099 commented Sep 25, 2024

I believe you have planted yourself firmly in the middle of the dreaded Variable Naming Convention debate, second only in brutality and death toll behind the infamous Spaces vs. Tabs debate!

image

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 DRep and DApp.

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!

image
You can see here that the answer is nearly as clear as mud!

But wait, there's more! Given that camelCase is more frequently used by the technical minded among us (buncha nerds), there is one further argument... that being: it is called camelCase because it resembles the humps on a camel, the Cardano Summit is being hosted in Dubai, where I rode a camel last year. Ergo, it should, without doubt and unequivocally be chosen as the de facto standard used for all abbreviations throughout the ecosystem uniformly.

I rest my case.

Copy link
Collaborator

@weqanhet weqanhet left a comment

Choose a reason for hiding this comment

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

LGTM

@katomm katomm merged commit 7875be7 into cardano-foundation:staging Sep 30, 2024
3 checks passed
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.

6 participants