Skip to content

Commit ab999ae

Browse files
committed
docs: remove outdated #[pyclass(text_signature = "...")] option (#4721)
1 parent 3a94a66 commit ab999ae

File tree

1 file changed

+0
-1
lines changed

1 file changed

+0
-1
lines changed

guide/pyclass-parameters.md

-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
| `set_all` | Generates setters for all fields of the pyclass. |
2222
| `str` | Implements `__str__` using the `Display` implementation of the underlying Rust datatype or by passing an optional format string `str="<format string>"`. *Note: The optional format string is only allowed for structs. `name` and `rename_all` are incompatible with the optional format string. Additional details can be found in the discussion on this [PR](https://github.com/PyO3/pyo3/pull/4233).* |
2323
| `subclass` | Allows other Python classes and `#[pyclass]` to inherit from this class. Enums cannot be subclassed. |
24-
| <span style="white-space: pre">`text_signature = "(arg1, arg2, ...)"`</span> | Sets the text signature for the Python class' `__new__` method. |
2524
| `unsendable` | Required if your struct is not [`Send`][params-3]. Rather than using `unsendable`, consider implementing your struct in a thread-safe way by e.g. substituting [`Rc`][params-4] with [`Arc`][params-5]. By using `unsendable`, your class will panic when accessed by another thread. Also note the Python's GC is multi-threaded and while unsendable classes will not be traversed on foreign threads to avoid UB, this can lead to memory leaks. |
2625
| `weakref` | Allows this class to be [weakly referenceable][params-6]. |
2726

0 commit comments

Comments
 (0)