Skip to content

Commit f8e8de8

Browse files
authored
docs: fix ambiguous doc refs (#1325)
2 parents 811d5fa + 2f2e8d7 commit f8e8de8

File tree

4 files changed

+14
-7
lines changed

4 files changed

+14
-7
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
### 43.3.5 [#1325](https://github.com/openfisca/openfisca-core/pull/1325)
4+
5+
#### Documentation
6+
7+
- Remove ambiguous documentation references.
8+
39
### 43.3.4 [#1302](https://github.com/openfisca/openfisca-core/pull/1302)
410

511
#### Technical changes

openfisca_core/populations/_core_population.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,22 @@ class CorePopulation:
2525
"""Base class to build populations from.
2626
2727
Args:
28-
entity: The :class:`.CoreEntity` of the population.
28+
entity: The :class:`~entities.CoreEntity` of the population.
2929
*__args: Variable length argument list.
3030
**__kwds: Arbitrary keyword arguments.
3131
3232
"""
3333

34-
#: The number :class:`.CoreEntity` members in the population.
34+
#: The number :class:`~entities.CoreEntity` members in the population.
3535
count: int = 0
3636

37-
#: The :class:`.CoreEntity` of the population.
37+
#: The :class:`~entities.CoreEntity` of the population.
3838
entity: t.CoreEntity
3939

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

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

4646
def __init__(self, entity: t.CoreEntity, *__args: object, **__kwds: object) -> None:
@@ -61,7 +61,7 @@ def __call__(
6161
options: The options to use for the calculation.
6262
6363
Returns:
64-
None: If there is no :class:`.Simulation`.
64+
None: If there is no :class:`~simulations.Simulation`.
6565
ndarray[generic]: The result of the calculation.
6666
6767
Raises:

openfisca_core/reforms/reform.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ def modify_parameters(self, modifier_function):
7171
Call this function in `apply()` if the reform asks for legislation parameter modifications.
7272
7373
Args:
74-
modifier_function: A function that takes a :obj:`.ParameterNode` and should return an object of the same type.
74+
modifier_function: A function that takes a :obj:`~parameters.ParameterNode`
75+
and should return an object of the same type.
7576
7677
"""
7778
baseline_parameters = self.baseline.parameters

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070

7171
setup(
7272
name="OpenFisca-Core",
73-
version="43.3.4",
73+
version="43.3.5",
7474
author="OpenFisca Team",
7575
author_email="[email protected]",
7676
classifiers=[

0 commit comments

Comments
 (0)