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

Variable Rename: props to property_entries #308

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

TheYellowArchitect
Copy link
Contributor

@TheYellowArchitect TheYellowArchitect commented Oct 16, 2024

It is easy to be confused with the variable names because of no static typings.
properties for example are not properties but PropertyEntries.
It makes it confusing to the reader as to what any variable is, especially new users to the codebase.

This PR had to be made because in the netfox discord I saw someone asking 'how can I sync props' and someone asked 'properties or props' and the reply was actually props ala prop hunt lol

Basically the current naming convention causes a lot of confusion.

The first suggestion and the implementation of this is to convert props to property_entries
The second suggestion is to rename property of type String to property_name, and have the name property be the PropertyEntry itself. I am against this second suggestion because this repo has no static typing as coding convention, so property being PropertyEntry is just weird, while property_entry being of type PropertyEntry is intuitive.

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.

2 participants