Repository navigation
Point module()'s type directive at update_module_params - #3509
Open
VenishPaneliya wants to merge 1 commit into
Open
VenishPaneliya wants to merge 1 commit into
VenishPaneliya wants to merge 1 commit into
Conversation
The docstring documents :param update_module_params: but gives its type as :type load_from_param_store:, a name the function does not take. Sphinx renders the type against that phantom name and leaves update_module_params untyped on the Primitives page.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
pyro.module()documents:param update_module_params:but gives its type as:type load_from_param_store: bool— a name the function does not take, and onethat appears nowhere else in the repo (it looks like a leftover from an old rename).
Sphinx binds a
:type X:to the parameter namedX, so on the Primitives page theboolis attached to a phantom entry while the realupdate_module_paramsrendersuntyped.
pyro.moduleis inpyro.__all__and the page is built withautomodule:: pyro.primitives :members:, so this is visible in the published docs.This is separate from #3485, which fixes
:paramnames in other modules and does nottouch
pyro/primitives.py.