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

Mention pub class in the documentation.

Browse source
This commit is contained in:
Daniel Grunwald 2017-01-19 21:56:06 +01:00
parent 06cab0a925
commit fbe1a07d10
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/py_class/py_class.rs
View file

@ -23,8 +23,9 @@ Additionally, it generates a Rust struct of the same name, which allows accessin
instances of that Python class from Rust.
# Syntax
`py_class!(class MyType |py| { ... })`
`py_class!(pub class MyType |py| { ... })`
* `pub` makes the generated Rust struct visible outside the current module. It has no effect on the visibility from Python.
* `MyType` is the name of the Python class.
* `py` is an identifier that will be made available as a variable of type `Python`
in all function bodies.