Skip to content

Fix syntax issues in docstrings in the code #1936

@Kami

Description

@Kami

When generating API documentation for various drivers using sphinx, tons and tons of warnings are printed due to an invalid docstring syntax in many places.

Those syntax issues should be fixed and once all the issues are fixed, sphinx and RTD config should be update to fail on warning. This way we will detect such issues early as part of CI.

Keep in mind that those fixes mostly can't be automated and it will be manual laborious and time intensive task.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions