-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
sync: improve documentation #24799
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
sync: improve documentation #24799
Conversation
Signed-off-by: Laurent Cheylus <[email protected]>
Signed-off-by: Laurent Cheylus <[email protected]>
Signed-off-by: Laurent Cheylus <[email protected]>
Signed-off-by: Laurent Cheylus <[email protected]>
Signed-off-by: Laurent Cheylus <[email protected]>
|
Connected to Huly®: V_0.6-23213 |
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.
Thank you, good work.
What do you think of the idea for making a dedicated tool, or adding an option to v doc, to report the . for public comments that miss them?
A potential benefit is that we could find and fix them all in one PR, then run it on the CI too, to keep the repo clean in that aspect.
Yes, I'm thinking to develop a specific tool/script to check functions documentation e.g. find if description ends with a final dot (+ others checks if possible). As you said, it could be a potential benefit to check documentation in CI. |
|
@lcheylus I've made |
|
For i.e. it may be a bit early to add that to the CI, but I can add something like this instead: to keep these ones from regressing. ) |
Various improvements and fix for documentation in
vlib/sync/: