Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix syntax issues in docstrings in the code #1936

Open
Kami opened this issue Aug 8, 2023 · 1 comment
Open

Fix syntax issues in docstrings in the code #1936

Kami opened this issue Aug 8, 2023 · 1 comment

Comments

@Kami
Copy link
Member

Kami commented Aug 8, 2023

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.

@Kami
Copy link
Member Author

Kami commented Aug 8, 2023

The biggest offender by far (hundreds of errors) is the Outscale compute driver.

To make this task more manageable, I think it makes a lot of sense to simply exclude Outscale driver from the API docs generation and focus on fixing syntax issues everywhere else to begin with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant