← Back to issue list

Validate library docstring are 100% ok to be rendered in Charmhub

View original Github issue

Metadata

Project
charmcraft
Number
#223
Type
issue
State
open
Author
facundobatista
Labels
Type: Enhancement
Created
2021-01-18 17:44:08+00:00
Updated
2025-09-10 17:44:00+00:00
Closed

Current evaluation

No evaluation has been recorded for this issue yet.

Issue body

On `charmcraft publish-lib` we could validate library docstrings: - that they comply with the [google convention](https://google.github.io/styleguide/pyguide.html) and other "style" verifications - that all attributes/arguments are properly explained in the respective docstrings, and other warnings that may arise when rendering docstrings to HTML (server is using [this extractor](https://pypi.org/project/docstring-extractor/))

Evaluation history

No evaluation history available.