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

Redundant declaration of some properties? #165

Closed
drnextgis opened this issue May 14, 2024 · 1 comment · Fixed by #170
Closed

Redundant declaration of some properties? #165

drnextgis opened this issue May 14, 2024 · 1 comment · Fixed by #170

Comments

@drnextgis
Copy link
Contributor

Why is it necessary to define the same property in some cases both at the class level and inside the constructor? For instance:

check_content_type: bool

def __init__(self, session: ClientSession, check_content_type: bool = True) -> None:

Isn't this redundant? Could docstring be added solely to the constructor instead?

It lacks consistency; for instance, the sas_token_endpoint is only defined within a constructor for PlanetaryComputerClient.

@gadomski
Copy link
Member

Thanks! I didn't understanding sphinx-autodoc well enough, and I thought I had to declare the docstrings on the class-level definitions. #170 should fix.

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

Successfully merging a pull request may close this issue.

2 participants