Skip to content

Commit aa9347d

Browse files
author
Martin Larralde
committed
Slightly fix documentation of tomlgen_rust
Signed-off-by: Martin Larralde <[email protected]>
1 parent 20a174f commit aa9347d

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

.travis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ install:
2121
- pip install -e .
2222

2323
script:
24-
- cd example && python setup.py develop
25-
- cd example_tomlgen && python setup.py tomlgen_rust && cat **.toml
24+
- cd example && python setup.py develop && cd ..
25+
- cd example_tomlgen && python setup.py tomlgen_rust -w && cd ..

setuptools_rust/tomlgen.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ def run(self):
9494
else:
9595
log.warn("skipping 'Cargo.toml' for workspace -- already exists")
9696

97+
# Create a `.cargo/config` file
9798
if self.create_workspace and self.extensions and not self.no_config:
9899

99100
dist = self.distribution
@@ -218,7 +219,10 @@ def find_rust_extensions(*directories, **kwargs):
218219
All other keyword arguments will be directly passed to the
219220
`RustExtension` instance created when an extension is found.
220221
One may be interested in passing ``bindings`` and ``strip``
221-
options.
222+
options::
223+
224+
>>> import setuptools_rust as rust
225+
>>> rust.find_rust_extensions(binding=rust.Binding.PyO3)
222226
223227
Example:
224228
@@ -232,7 +236,8 @@ def find_rust_extensions(*directories, **kwargs):
232236
└ Cargo.toml
233237
setup.py
234238
235-
The only extension can be found in the ``lib`` module::
239+
There is only one extension that can be found in the ``lib``
240+
module::
236241
237242
>>> import setuptools_rust as rust
238243
>>> for ext in rust.find_rust_extensions("lib"):

0 commit comments

Comments
 (0)