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 docs and fix copy() type #23

Merged
merged 5 commits into from
Feb 22, 2024
Merged

Conversation

llucax
Copy link
Contributor

@llucax llucax commented Feb 22, 2024

  • Make TypeVars public
  • Import symbols from typing as top-level
  • Make default values public
  • Use Self instead of RetryStrategy in copy method signature
  • Update release notes

@llucax llucax requested a review from a team as a code owner February 22, 2024 10:36
@llucax llucax requested a review from shsms February 22, 2024 10:36
@llucax llucax self-assigned this Feb 22, 2024
@github-actions github-actions bot added the part:docs Affects the documentation label Feb 22, 2024
@llucax llucax enabled auto-merge February 22, 2024 10:43
Marenz
Marenz previously approved these changes Feb 22, 2024
@llucax llucax added this pull request to the merge queue Feb 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Feb 22, 2024
The `TypeVar`s `_InputT` and `_OutputT` are not really private, as they
are used in public classes, so they should be public so they render
correctly in the docs. We also add documentation to them.

Signed-off-by: Leandro Lucarella <[email protected]>
This is the recommendation in Google-style and is also necessary to
enable some of the `pydoclint` checks.

Signed-off-by: Leandro Lucarella <[email protected]>
They are used as default for public symbols, so they should be public
too, so they render in the documentation.

Signed-off-by: Leandro Lucarella <[email protected]>
Otherwise the copied type can't be used as the real type of the
subclass.

Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
@llucax
Copy link
Contributor Author

llucax commented Feb 22, 2024

Rebased to solve conflicts and enabled auto-merge, needs another approval.

@llucax llucax requested a review from Marenz February 22, 2024 11:11
@llucax llucax added this pull request to the merge queue Feb 22, 2024
Merged via the queue into frequenz-floss:v0.x.x with commit 03f2ed2 Feb 22, 2024
14 checks passed
@llucax llucax deleted the generics-docs branch February 22, 2024 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:docs Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants