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

doc/mgr: svc_name is modified to svc_id #13719

Closed
wants to merge 1 commit into from

Conversation

renhwztetecs
Copy link
Contributor

svc_name is modified to svc_id,
refer to the definition of "static PyObject* get_counter(...)"

Signed-off-by: huanwen ren ren.huanwen@zte.com.cn

svc_name is modified to svc_id,
refer to the definition of "static PyObject* get_counter(...)"

Signed-off-by: huanwen ren <ren.huanwen@zte.com.cn>
@shinobu-x
Copy link
Contributor

jenkins test this please

@jcsp
Copy link
Contributor

jcsp commented Mar 1, 2017

This isn't really necessary, because it's a positional argument -- what's currently in the docs just corresponds to what it's called in mgr_module.py.

If you want to update the code to make the C++ side use the same names as the python side for arguments that would probably benefit readability though.

@renhwztetecs
Copy link
Contributor Author

I think the update code seems to be nothing necessary
I have another doubt,
as follows:
get_metadata(self, svc_type, svc_id) and get_counter(self, svc_type, svc_name, path).

I understand that "svc_id" and "svc_name" are the same, so
I change get_counter(self, svc_type, svc_name, path) to
get_counter(self, svc_type, svc_id, path) , it makes the
document more readable.

thank you

@jcsp
Copy link
Contributor

jcsp commented Apr 15, 2017

I just don't think it makes sense to have something in the python module docs that is different from the definition in mgr_module.py for get_counter.

If you want to open a new PR that cleans up the name vs. id terminology across the interface, that would be welcome, but this doc edit I don't think makes sense in its current form.

@jcsp jcsp closed this Apr 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants