Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Piotr Spieker <orzechow@posteo.de>
  • Loading branch information
ll-nick and orzechow authored Dec 6, 2024
1 parent 5e145c2 commit 3d21e07
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ More usage please check the unittest.
## Python bindings

The library can be used in Python via pybind11 bindings.
Since util_caching is a template library,
Since `util_caching` is a templated C++ library,
you need to explicitly instantiate the template for the types you want to use in Python.
For this, we provide convenience functions to bind the library for the desired types.
Simply call them in a pybind11 module definition, e.g.:
Expand Down Expand Up @@ -133,8 +133,8 @@ find_package(util_caching REQUIRED)
### Building from source using CMake

First make sure all dependencies are installed:
- [Googletest](https://github.com/google/googletest) (only if you want to build unit tests)
- [pybind11](https://pybind11.readthedocs.io/en/stable/) (only if you want to build Python bindings and unit tests)
- [Googletest](https://github.com/google/googletest) (optional, if you want to build unit tests)
- [pybind11](https://pybind11.readthedocs.io/en/stable/) (optional, if you want to build Python bindings and unit tests)

See also the [`Dockerfile`](./Dockerfile) for how to install these packages under Debian or Ubuntu.

Expand Down
2 changes: 1 addition & 1 deletion test/python_bindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ struct SomePolicyWithoutParams {
};

/*!
* \brief The python module definition that allows running equivalent unit tests in python.
* \brief The python module definition that allows running python unit tests equivalent to the native C++ ones.
*/
PYBIND11_MODULE(util_caching_py, mainModule) {
// Just some aliases to make the code more readable
Expand Down

0 comments on commit 3d21e07

Please sign in to comment.