-
Notifications
You must be signed in to change notification settings - Fork 35
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
Docs: improve coding guidelines #1112
Conversation
Affected libs:
|
📷 Screenshots are 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.
Thanks @jahow for adding so much useful information ! 😃
I think it looks really good. I did notice a small "coquille" (see comment) & I was thinking that maybe we could add details on the libs import dependencies (which libs can/cannot be imported where, to avoid circular dependencies) ? Or maybe it can be done later, that was just an idea !
Very good idea... That will have to be done in another PR but definitely a very good thing to add! |
@cmoinier I ended up documenting the dependencies, hope it's clear enough! |
Thank you, that looks good! |
Description
This PR improves the documentation by adding a dedicated "for developers" section with coding guidelines, reorganizing doc sections, and making everything hopefully more readable.
Quality Assurance Checklist
breaking change
labelbackport <release branch>
label