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

Refactor: Naming convention of functions in client differs from example name #86

Open
vprusso opened this issue Jul 31, 2023 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@vprusso
Copy link
Contributor

vprusso commented Jul 31, 2023

The name of the function in client.py should match the associated example in examples/

For instance, the function task_names_get(self) in client.py has an associated example of examples/task_get_names.

Preferably, the naming convention should be:

<OBJECT>_<ACTION>_<RETURN>

So, in this case, the object is "task", the action is "get", and the return is "names". This would yield a consistent name of task_get_names for both the client function and example file name. This convention should be applied to all of the examples and client functions.

@vprusso vprusso added enhancement New feature or request good first issue Good for newcomers labels Jul 31, 2023
@srilakshmip03
Copy link
Contributor

I can get started on this one

@vprusso
Copy link
Contributor Author

vprusso commented Aug 2, 2023

Awesome, @srilakshmip03 !

Let me know if I can provide any additional help or context! Looking forward to seeing what you put together!

@srilakshmip03
Copy link
Contributor

@vprusso I had to make a fork and open a pull request from there since I don't think I have write access to this repo - it should be the only open PR now though and that has all of the updates!

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

No branches or pull requests

2 participants