luxolus/pyo3
2
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Merge pull request #1353 from daniil-konovalenko/patch-1

Browse source 
Fix #[pyclass] arguments description
This commit is contained in:
David Hewitt 2021-01-02 17:00:13 +00:00 committed by GitHub
parent 42ca48a8b4 74a8b3257d
commit d9ccc98565
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
guide/src/class.md
View file

@ -131,7 +131,7 @@ assert_eq!(obj_ref.num, 1);
The `#[pyclass]` macro accepts the following parameters:
* `name=XXX` - Set the class name shown in Python code. By default, the struct name is used as the class name.
* `name="XXX"` - Set the class name shown in Python code. By default, the struct name is used as the class name.
* `freelist=XXX` - The `freelist` parameter adds support of free allocation list to custom class.
The performance improvement applies to types that are often created and deleted in a row,
so that they can benefit from a freelist. `XXX` is a number of items for the free list.