search

openfisca / openfisca-core

OpenFisca core engine. See other repositories for countries-specific code & data.
https://openfisca.org
GNU Affero General Public License v3.0
168 stars 75 forks source link

Remove ambiguous docstring references #1128

Closed MattiSG closed 2 years ago

MattiSG commented 2 years ago

Some docstring refs are ambiguous. Until now, these warnings were not raised. Following updates in the documentation generation system, these references now raise errors when compiled and block documentation updates. This changeset removes links that are ambiguous so that the documentation can be generated again.

coveralls commented 2 years ago

Coverage Status

Coverage remained the same at 78.922% when pulling d5912af19deab9ef86c261a9c03d5436d66bad7b on fix-doc-refs into 8496a92e5ff6bf4ab60293c51df5beb1e125e1b3 on master.

MattiSG commented 2 years ago

I understand that :any: instructs the documentation builder to look for this definition in any class or module, even third-party ones. This makes it faster to write the doc as you don't need to find the fully-qualified namespace for a function, but it might be ambiguous. In the cases I changed, I did not have enough time nor knowledge to find the full names, but the ambiguity led the engine to not know which link to create, which following the dependencies updates in openfisca/openfisca-doc#264 became blocking for compiling the doc.