Skip to content

Improve the "Platform documentation" page on how to write docs #2393

@panglesd

Description

@panglesd

The platform tool guide on how to write documentation is minimal.

I think it would benefit from some examples, explanation on what is a docstring and how it is attached to an item, some explanation of the (basic) syntax, etc. Another content could be "what kind of content to put in docstrings", but this is a bit more personal.

I can give it a shot if there is no volunteer!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    📋 Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions