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 not matching return types in Strategy docs #2432

Merged
merged 4 commits into from
Oct 7, 2023

Conversation

adam-narozniak
Copy link
Member

@adam-narozniak adam-narozniak commented Sep 29, 2023

Issue

We keep the types parameters as type hints in code and in docs. In Strategy the docs return types do not reflect the type hints return types.

Description

aggregate_fit and aggregate_evaluate docs return types do not match the type hints in the code

Proposal

Fix the docs return types.

Explanation

The type hints are correct based on the code functionality therefore, the docs types need to be changed.

doc/source/ref-changelog.md Outdated Show resolved Hide resolved
@danieljanes danieljanes enabled auto-merge (squash) October 7, 2023 15:47
@danieljanes danieljanes merged commit 6df3e86 into main Oct 7, 2023
26 checks passed
@danieljanes danieljanes deleted the fix-incorrect-strategy-docs-return-types branch October 7, 2023 15:51
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