On 2020-03-16 09:40 +0100, Sebastian Huber wrote: > > I work currently on a draft for the Python development guidelines for the > engineering manual. I hope to have something ready for review in the next > days. > > Documenting the tests with with pydoc strings in general would be overkill > from > my point of view.
Yes, typically the test names themselves are self-explanatory. If they aren't then larger tests should be broken into smaller one with descriptive names. Documentation should be in the source code itself. Documenting it twice is a longterm nightmare as eventually either-or will deviate from each other while the documentation doesn't change. Only in rare cases when a test does something non-obvious should there be any documentation and even then that's usually not at the function level but above the code snippet. Amar. _______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel