Skip to content
  • Simon Ser's avatar
    contributing: add section about documentation conventions · 27383a19
    Simon Ser authored and Simon Zeni's avatar Simon Zeni committed
    Document the existing conventions.
    
    Use `mystruct.foo` instead of `mystruct::foo` because `::` is pretty
    alien to C.
    
    Instead of backticks, use a different format to reference declarations
    in our docs:
    
        See foo().
        See struct foo.
        See union bar.
        See enum baz.
        See typedef meh.
    
    This is inspired by the kernel's documentation style [1]. This format
    has the upside of being pretty natural to write and read, and can be
    automatically processed by documentation generators.
    
    [1]: https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#cross-referencing-from-restructuredtext
    27383a19
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.