Skip to content

Commit b4f78c0

Browse files
committed
fix rumdl formatting
1 parent 0497d48 commit b4f78c0

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

guide/src/class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1312,7 +1312,7 @@ Python::attach(|py| {
13121312
# .unwrap();
13131313
```
13141314

1315-
WARNING: `Py::new` and `.into_pyobject` are currently inconsistent. Note how the constructed value is _not_ an instance of the specific variant. For this reason, constructing values is only recommended using `.into_pyobject`.
1315+
WARNING: `Py::new` and `.into_pyobject` are currently inconsistent. Note how the constructed value is *not* an instance of the specific variant. For this reason, constructing values is only recommended using `.into_pyobject`.
13161316

13171317
```rust
13181318
# use pyo3::prelude::*;

guide/src/class/protocols.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ given signatures should be interpreted as follows:
7878
7979
The implementations of Python's "rich comparison" operators `<`, `<=`, `==`, `!=`, `>` and `>=` respectively.
8080
81-
_Note that implementing any of these methods will cause Python not to generate a default `__hash__` implementation, so consider also implementing `__hash__`._
81+
*Note that implementing any of these methods will cause Python not to generate a default XXXXXXXXXX implementation, so consider also implementing XXXXXXXXXX.*
8282
<details>
8383
<summary>Return type</summary>
8484
The return type will normally be `bool` or `PyResult<bool>`, however any Python object can be returned.
@@ -90,9 +90,9 @@ given signatures should be interpreted as follows:
9090
The `CompareOp` argument indicates the comparison operation being performed. You can use
9191
[`CompareOp::matches`] to adapt a Rust `std::cmp::Ordering` result to the requested comparison.
9292
93-
_This method cannot be implemented in combination with any of `__lt__`, `__le__`, `__eq__`, `__ne__`, `__gt__`, or `__ge__`._
93+
*This method cannot be implemented in combination with any of XXXXXXXX, XXXXXXXX, XXXXXXXX, XXXXXXXX, XXXXXXXX, or XXXXXXXX.*
9494
95-
_Note that implementing `__richcmp__` will cause Python not to generate a default `__hash__` implementation, so consider implementing `__hash__` when implementing `__richcmp__`._
95+
*Note that implementing XXXXXXXXXXXXX will cause Python not to generate a default XXXXXXXXXX implementation, so consider implementing XXXXXXXXXX when implementing XXXXXXXXXXXXX.*
9696
<details>
9797
<summary>Return type</summary>
9898
The return type will normally be `PyResult<bool>`, but any Python object can be returned.

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ disable = [
3333
# TODO: what to do about inline HTML, probably allow?
3434
"MD033",
3535
# TODO: {{#PYO3_DOCS_URL}} placeholder confuses rumdl, change syntax perhaps?
36-
"MD051"
36+
"MD051",
37+
# Disabled on release-0.27 branch
38+
"MD059",
3739
]
3840

3941
exclude = [

0 commit comments

Comments
 (0)