Skip to content

Commit e7b6439

Browse files
committed
Fix warnings
1 parent c8ec779 commit e7b6439

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

docs/learn/concepts/addition.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,11 @@ Option 2 hardly seems reasonable this time considering that air emissions make u
213213

214214
In practice, you'll find that it is common to want to keep extra labels on both sides of an addition or subtraction. As such, Pyoframe offers the bitwise OR operator (`|`) as a convenient shortcut. Instead of
215215

216+
<!-- invisible-code-block: python
217+
a = model.air_emissions
218+
b = model.ground_emissions
219+
-->
220+
216221
```python
217222
a.keep_extras() + b.keep_extras()
218223
```

docs/learn/migrate/v1.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Pyoframe version 1.0 brings major improvements :tada:
66
- **Bug fixes:** notably with `Variable(equals=…)` not properly parsing DataFrames.
77
- **Improved performance** after rewriting internal functions based on extensive benchmarking.
88
- **Smoother developer experience**, notably error messages explain the mathematical operations that led to an error and Pyoframe objects now print as legible tables.
9-
- **Improved documentation** including a revamped [API page](../../reference/index.md), an [examples page](../../examples/index.md), new explanations of functions like [`.over(…)`](../concepts/addition.md#adding-expressions-with-differing-dimensions-using-over), and the ability to view previous versions of the documentation.
9+
- **Improved documentation** including a revamped [API page](../../reference/index.md), an [examples page](../../examples/index.md), new explanations of functions like [`.over(…)`](../concepts/addition.md#over), and the ability to view previous versions of the documentation.
1010
- **More readable syntax** like our decision to rename `add_dim` to `over` and the changes to `.sum()` (see below).
1111

1212
Unfortunately, these improvements involve some breaking changes. This page will guide you in migrating your code to v1.0.
@@ -78,7 +78,7 @@ Please update all uses of `pf.sum` and `pf.sum_by` accordingly.
7878

7979
### 3. Rename `.add_dim(…)` to `.over(…)`
8080

81-
For clarity, `.add_dim(…)` was renamed to [`.over(…)`](../concepts/addition.md#adding-expressions-with-differing-dimensions-using-over). Please update your code accordingly.
81+
For clarity, `.add_dim(…)` was renamed to [`.over(…)`](../concepts/addition.md#over). Please update your code accordingly.
8282

8383
```python
8484
m.X.add_dim("time") # before

src/pyoframe/_core.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2240,7 +2240,7 @@ class Variable(BaseOperableBlock):
22402240
"""A decision variable for an optimization model.
22412241
22422242
!!! tip
2243-
If `lb` or `ub` are a dimensioned object (e.g. an [Expression][pyoframe.Expression]), they will automatically be [broadcasted](../../learn/concepts/addition.md#adding-expressions-with-differing-dimensions-using-over) to match the variable's dimensions.
2243+
If `lb` or `ub` are a dimensioned object (e.g. an [Expression][pyoframe.Expression]), they will automatically be [broadcasted](../../learn/concepts/addition.md#over) to match the variable's dimensions.
22442244
22452245
Parameters:
22462246
*indexing_sets:

0 commit comments

Comments
 (0)