Skip to content

Point module()'s type directive at update_module_params - #3509

Open
VenishPaneliya wants to merge 1 commit into
pyro-ppl:devfrom
VenishPaneliya:module-type-directive
Open

VenishPaneliya wants to merge 1 commit into
pyro-ppl:devfrom
VenishPaneliya:module-type-directive

Conversation

@VenishPaneliya

Copy link
Copy Markdown

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 one
that appears nowhere else in the repo (it looks like a leftover from an old rename).

Sphinx binds a :type X: to the parameter named X, so on the Primitives page the
bool is attached to a phantom entry while the real update_module_params renders
untyped. pyro.module is in pyro.__all__ and the page is built with
automodule:: pyro.primitives :members:, so this is visible in the published docs.

This is separate from #3485, which fixes :param names in other modules and does not
touch pyro/primitives.py.

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

No deployments
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.

1 participant