Skip to content

Commit 62a4639

Browse files
committed
Change links to the source with links to the docs
For APIs now we can use cross-referencing, which is more user-friendly but also easier to maintain as we only need to update the version we want to point to in one place (the `mkdocs.yml` file). Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 8fe9ee3 commit 62a4639

File tree

2 files changed

+30
-10
lines changed

2 files changed

+30
-10
lines changed

src/frequenz/sdk/microgrid/component/_component_data.py

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,9 @@ class BatteryData(ComponentData):
137137
This is the lower limit of the range within which power requests are allowed for the
138138
battery.
139139
140-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
140+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
141+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
142+
details.
141143
"""
142144

143145
power_exclusion_lower_bound: float
@@ -146,7 +148,9 @@ class BatteryData(ComponentData):
146148
This is the lower limit of the range within which power requests are not allowed for
147149
the battery.
148150
149-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
151+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
152+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
153+
details.
150154
"""
151155

152156
power_inclusion_upper_bound: float
@@ -155,7 +159,9 @@ class BatteryData(ComponentData):
155159
This is the upper limit of the range within which power requests are allowed for the
156160
battery.
157161
158-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
162+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
163+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
164+
details.
159165
"""
160166

161167
power_exclusion_upper_bound: float
@@ -164,7 +170,9 @@ class BatteryData(ComponentData):
164170
This is the upper limit of the range within which power requests are not allowed for
165171
the battery.
166172
167-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
173+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
174+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
175+
details.
168176
"""
169177
# pylint: enable=line-too-long
170178

@@ -228,7 +236,9 @@ class InverterData(ComponentData):
228236
This is the lower limit of the range within which power requests are allowed for the
229237
inverter.
230238
231-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
239+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
240+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
241+
details.
232242
"""
233243

234244
active_power_exclusion_lower_bound: float
@@ -237,7 +247,9 @@ class InverterData(ComponentData):
237247
This is the lower limit of the range within which power requests are not allowed for
238248
the inverter.
239249
240-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
250+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
251+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
252+
details.
241253
"""
242254

243255
active_power_inclusion_upper_bound: float
@@ -246,7 +258,9 @@ class InverterData(ComponentData):
246258
This is the upper limit of the range within which power requests are allowed for the
247259
inverter.
248260
249-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
261+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
262+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
263+
details.
250264
"""
251265

252266
active_power_exclusion_upper_bound: float
@@ -255,7 +269,9 @@ class InverterData(ComponentData):
255269
This is the upper limit of the range within which power requests are not allowed for
256270
the inverter.
257271
258-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
272+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
273+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
274+
details.
259275
"""
260276
# pylint: enable=line-too-long
261277

src/frequenz/sdk/timeseries/battery_pool/_result_types.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ class PowerMetrics:
3737
When exclusion bounds are present, they will exclude a subset of the inclusion
3838
bounds.
3939
40-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
40+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
41+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
42+
details.
4143
"""
4244

4345
exclusion_bounds: Bounds
@@ -46,6 +48,8 @@ class PowerMetrics:
4648
This is the range within which power requests are NOT allowed by the battery pool.
4749
If present, they will be a subset of the inclusion bounds.
4850
49-
More details [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.3.0/proto/frequenz/api/common/metrics.proto#L37-L91).
51+
See [`frequenz.api.common.metrics_pb2.Metric.system_inclusion_bounds`][] and
52+
[`frequenz.api.common.metrics_pb2.Metric.system_exclusion_bounds`][] for more
53+
details.
5054
"""
5155
# pylint: enable=line-too-long

0 commit comments

Comments
 (0)