api: add comments on fields for reference docs#959
Conversation
1c4777f to
1173eca
Compare
|
Thanks @willfindlay, I added some of your API changes suggestion there #486 (comment). |
sharlns
left a comment
sharlns
left a comment
There was a problem hiding this comment.
Amazing, LGTM. Thank you! :)
| // general flow to exec* a new process, however its possible to replace the | ||
| // current process with a new process by doing an exec* without a clone. In | ||
| // this case the flag will be omitted and the same PID will be used by the | ||
| // kernel for both the old process and the newly exec'd process. |
There was a problem hiding this comment.
This field is somehow for debugging, it contains some values that may not change but others may...
Would be better to add something like:
The flags is for debugging purposes only and should not be relied upon to propagate comprehensive information.
There was a problem hiding this comment.
when you say "add" you mean append this at the end or at the beginning or replacing the whole flag documentation with this?
There was a problem hiding this comment.
I'm fine adding it at the beginning so it is clear and we keep current doc that you added, the developers are on their own here... ;-)
There was a problem hiding this comment.
btw have you seen the related discussion on transforming this into an enum:
- api: add comments on fields for reference docs #959 (comment)
- changes to tracing policy API (v1alpha1) and gRPC API (v1) #486 (comment)
Ok let's add that so that we merge this doc!
There was a problem hiding this comment.
f4a972a to
46156cc
Compare
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
151f576 to
effac5a
Compare
Also remove empty lines in comments because Markdown does not support table cell with newlines. Signed-off-by: Mahe Tardy <mahe.tardy@gmail.com>
effac5a to
d8384c2
Compare
|
Check failure is related to dependabot.yaml config format fails and I have an open PR to fix that. Let's merge this. |
4 participants
Fixes #957.
This PR includes no functional changes. Only comments for autogenerated documentation.
I need your help with a few fields.