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

Rename Variable, Function, and Contract names Sensibly #277

Open
daweth opened this issue Aug 23, 2023 · 2 comments
Open

Rename Variable, Function, and Contract names Sensibly #277

daweth opened this issue Aug 23, 2023 · 2 comments

Comments

@daweth
Copy link

daweth commented Aug 23, 2023

The naming conventions in the DSS contracts lack common sense.

The purpose of names are to describe the behavior of the function or variable. On a more local scale more general names such as "item", "vat", etc. are fine. But the high level naming of DSS are absolutely absurd.

Without docs, this code would be very difficult to decipher

I propose a complete renaming of the contracts andfunctions that actually reflect their function, rather than random "cat" and "dog" contracts

@daweth daweth changed the title Rename Variable and Contract names to Sensible Descriptors Rename Variable, Function, and Contract names Sensibly Aug 23, 2023
@brianmcmichael
Copy link
Contributor

@daweth
Copy link
Author

daweth commented Sep 11, 2023

@brianmcmichael

  1. "we sidestep terminological debates" by making the terminology dogs and cats
  2. "we invent our own language because financial language isn't good enough and our readers can't understand it", they are less likely to understand "cat" "dog" and "bite" language (unless they are 5 years old)
  3. "makes the structures easier to explain bc variables shorter", yeah you have shorter names, but the fundamental rule of naming is to make sure your code communicates what it is doing. If this is your goal why not go all the way and name the contracts "a", "b", "c", etc.?

I don't think the points made in that screenshot make any logical sense.

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

No branches or pull requests

2 participants