RFC about Docstrings: a step towards in code documentation

RFC just opened and looking for contributers

I need your feedback and opinions about it
and would be very delighted to hear about them.

The reason i created this is because i‘d like to generate static documentation from nix code. This is already done via a tool called ‚nixdoc‘ however it is very custom built and there is no standard how to write in code-documentation

There is even no way to differentiate a comment from a doc-string/doc-block. Essentially this is my goal.

I’m aware there are some technical open questions; I discussed those briefly in the rfc although the draft may not yet have all answers.

Also: If you are interested to be\join:

  • co-author

  • shepherd team

Please comment accordingly