Skip to content

Commit

Permalink
minor doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
virgesmith committed Dec 3, 2023
1 parent d3b6d38 commit adec5c2
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@

## Type stubs

Type stubs were generated for the core C++ library using the `pybind11-stubgen` package, although significant editing of the output was required. See `__init__.pyi` for details.
Type stubs were generated for the core C++ library using the `pybind11-stubgen` package, with minor manual corrections. See `__init__.pyi` for details.
2 changes: 1 addition & 1 deletion docs/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The script from [codecov.io](https://codecov.io/gh/virgesmith/neworder/) uses `g

## Generating type stubs

Type stubs can be generated for the C++ module using `pybind11-stubgen`, although manual modifications are needed for the output (e.g. docstrings for overloaded functions are misplaced, numpy types need to be fixed).
Type stubs can be generated for the C++ module using `pybind11-stubgen`, although manual modifications may be needed, plus numpy types need to be fixed globally.

```sh
pybind11-stubgen _neworder_core --ignore-invalid all
Expand Down

0 comments on commit adec5c2

Please sign in to comment.