search

unitaryfund / metriq-client

Fork of papers-with-code client
https://metriq.info
Apache License 2.0
3 stars 9 forks source link

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

Open vprusso opened 1 year ago

vprusso commented 1 year ago

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.

srilakshmip03 commented 1 year ago

I can get started on this one

vprusso commented 1 year ago

Awesome, @srilakshmip03 !

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

srilakshmip03 commented 1 year ago

@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!