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

improve declarations.Provides documentation #274

Merged
merged 1 commit into from
Sep 7, 2023

Conversation

d-maurer
Copy link
Contributor

The signature of declarations.Provides is given as *interfaces. This is wrong; it actually is cls, *interfaces where cls is the class of the instance for which Provides should provide a declaration. This parameter is necessary to avoid the construction of inconsistent resolution orders.

The PR does not change the code but improves the Provides docstring and especially documents the correct signature there.

@jugmac00
Copy link
Member

jugmac00 commented Aug 24, 2023

As you mention that the signature is wrong, what prevents you from updating it?

@d-maurer
Copy link
Contributor Author

d-maurer commented Aug 24, 2023 via email

@d-maurer d-maurer merged commit 31dba21 into master Sep 7, 2023
38 checks passed
@d-maurer d-maurer deleted the document_Provides_signature branch September 7, 2023 08:04
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 this pull request may close these issues.

2 participants