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

Provide descriptive function names #2

Closed
Nedlinin opened this issue Feb 3, 2020 · 0 comments · Fixed by #5
Closed

Provide descriptive function names #2

Nedlinin opened this issue Feb 3, 2020 · 0 comments · Fixed by #5
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@Nedlinin
Copy link
Collaborator

Nedlinin commented Feb 3, 2020

Ensure all function names are descriptive as to what they actually do. Preferably ensure comments above the function to describe their intended purpose.

For instance: "Perhaps exceeds_threshold should be named something more descriptive as it is returning a full object rather than a boolean. "get_artist_info" or "get_service_info" or similar?"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants