Remove initval from dist()
API and add docstrings, type hints, tests
#4913
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes
initial_values
a property with docstring and type hints. It also adds some more type hints and docstrings to related functions and properties.For the
UNSET
constant I added its own type, because inspecting signatures withUNSET
kwargs (for examplepm.Normal
) results in confusing output, as demonstrated by this example:With the new repr it just becomes
Depending on what your PR does, here are a few things you might want to address in the description:
what are the (breaking) changes that this PR makes?Noneconsider adding/updating relevant example notebooksright before it's ready to merge, mention the PR in the RELEASE-NOTES.mdnot relevant enough