On Thu, Feb 6, 2025 at 4:55 PM Matteo Golin <matteo.go...@gmail.com> wrote:
> If I may add to the proposed contributing guideline changes: all changes
> affecting behaviour/APIs or adding features should be properly documented,
> not just within the PR. NuttX has many features and lots of apps for using
> them, but a lot of them are left undocumented outside of inline comments or
> PR descriptions. I think if changes are made then corresponding RST
> documentation for the website should be made/updated too. This lets us look
> for information in one unified place, especially for users who have no
> interest in grepping through the source code.
>
> With this requirement, all of the sensor drivers and apps that currently
> have no documentation would have been documented, for instance. This saves
> work for the project later since we don't have to go back and re-read the
> code to document things.

+1 :-) Excellent idea, thanks Matteo! :-)

-- 
CeDeROM, SQ7MHZ, http://www.tomek.cedro.info

Reply via email to