-
Notifications
You must be signed in to change notification settings - Fork 292
Add mlis for observer_helpers and observer_skeleton #6539
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
base: master
Are you sure you want to change the base?
Add mlis for observer_helpers and observer_skeleton #6539
Conversation
We probably want to add some documentation-comments to the type signatures here |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some functions have multiple string parameters, no labels, and no documentation.
8ec5b90
to
663c08d
Compare
They are all based on the ObserverAPI module, but that's an RPC interface definition using declare , which I don't think I can label, so I don't know what the best way to do this would be? I could add a documentation string for each function like:
|
Documenting them is good, see how parameters are documented in many of the interface files, this one for example: https://github.com/xapi-project/xen-api/blob/master/ocaml/xapi-idl/xen/device_number.mli#L23 |
Signed-off-by: Steven Woods <[email protected]>
663c08d
to
e424f75
Compare
(** [create dbg uuid name attributes endpoints enabled] is for when the | ||
Observer is created. [uuid] is the Observer which has been created and | ||
the parameters following are the fields the Observer was created with. *) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This wording is a bit strange, usually what's explained is the expected result in terms of the input, something like:
(** [create dbg uuid name attributes endpoints enabled] is for when the | |
Observer is created. [uuid] is the Observer which has been created and | |
the parameters following are the fields the Observer was created with. *) | |
(** [create dbg uuid name attributes endpoints enabled] creates an | |
Observer with UUID [uuid]. *) |
No description provided.