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

DOC: conflicting fixed_params type-hint in find_constrained_prior #7341

Open
wd60622 opened this issue May 31, 2024 · 1 comment
Open

DOC: conflicting fixed_params type-hint in find_constrained_prior #7341

wd60622 opened this issue May 31, 2024 · 1 comment
Labels

Comments

@wd60622
Copy link
Contributor

wd60622 commented May 31, 2024

Issue with current documentation:

The find_contrained_prior documentation page has "str or float, optional, default None" in the docstring type hint but dict[str, float] in the examples and function signature

Idea or request for content:

Consolidate to the correct type hint. I believe it is dict[str, float]

@wd60622 wd60622 added the docs label May 31, 2024
@ricardoV94
Copy link
Member

The docstring about only when there are more than 2 params to optimize also seems wrong. Perhaps something that was true in earlier iterations but is no longer?

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

No branches or pull requests

2 participants