Skip to content

docs: fix ambiguous doc refs #1325

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 17, 2025
Merged

docs: fix ambiguous doc refs #1325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0086c58
docs: fix ambiguous doc refs
bonjourmauko Mar 17, 2025
2f2e8d7
chore: version bump
bonjourmauko Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

### 43.3.5 [#1325](https://github.com/openfisca/openfisca-core/pull/1325)

#### Documentation

- Remove ambiguous documentation references.

### 43.3.4 [#1302](https://github.com/openfisca/openfisca-core/pull/1302)

#### Technical changes
Expand Down
10 changes: 5 additions & 5 deletions openfisca_core/populations/_core_population.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,22 @@ class CorePopulation:
"""Base class to build populations from.

Args:
entity: The :class:`.CoreEntity` of the population.
entity: The :class:`~entities.CoreEntity` of the population.
*__args: Variable length argument list.
**__kwds: Arbitrary keyword arguments.

"""

#: The number :class:`.CoreEntity` members in the population.
#: The number :class:`~entities.CoreEntity` members in the population.
count: int = 0

#: The :class:`.CoreEntity` of the population.
#: The :class:`~entities.CoreEntity` of the population.
entity: t.CoreEntity

#: A pseudo index for the members of the population.
ids: Sequence[str] = []

#: The :class:`.Simulation` for which the population is calculated.
#: The :class:`~simulations.Simulation` for which the population is calculated.
simulation: None | t.Simulation = None

def __init__(self, entity: t.CoreEntity, *__args: object, **__kwds: object) -> None:
Expand All @@ -61,7 +61,7 @@ def __call__(
options: The options to use for the calculation.

Returns:
None: If there is no :class:`.Simulation`.
None: If there is no :class:`~simulations.Simulation`.
ndarray[generic]: The result of the calculation.

Raises:
Expand Down
3 changes: 2 additions & 1 deletion openfisca_core/reforms/reform.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ def modify_parameters(self, modifier_function):
Call this function in `apply()` if the reform asks for legislation parameter modifications.

Args:
modifier_function: A function that takes a :obj:`.ParameterNode` and should return an object of the same type.
modifier_function: A function that takes a :obj:`~parameters.ParameterNode`
and should return an object of the same type.

"""
baseline_parameters = self.baseline.parameters
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@

setup(
name="OpenFisca-Core",
version="43.3.4",
version="43.3.5",
author="OpenFisca Team",
author_email="[email protected]",
classifiers=[
Expand Down
Loading