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

Function name style #42

Open
asquared opened this issue Sep 6, 2015 · 0 comments
Open

Function name style #42

asquared opened this issue Sep 6, 2015 · 0 comments

Comments

@asquared
Copy link
Member

asquared commented Sep 6, 2015

While investigating #41 I discovered we have a bit of a consistency issue with function names. Some functions are "active voice" (verb-noun - e.g. postGlobalStatus, putGameState) while others are "passive voice" (noun-verb - e.g. fieldGoalDisplay, ddDisplay). Some don't even have a verb (e.g. ytgCustom) Since it's rare in English for the object of a verb to come before the verb, I would recommend that we change these to the verb-noun style (e.g. "displayFieldGoalAttempt", "displayDownDistance") or add a verb if needed (e.g. setCustomYtg).

If we tackle this soon we should do it in a branch and test thoroughly because making changes like this could break all kinds of things.

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

1 participant