From 3d21e0718f98c417dcb06a33abb3565c8a4179dd Mon Sep 17 00:00:00 2001 From: ll-nick <68419636+ll-nick@users.noreply.github.com> Date: Fri, 6 Dec 2024 11:37:39 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Piotr Spieker --- README.md | 6 +++--- test/python_bindings.cpp | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7eb09a6..f19eaaa 100644 --- a/README.md +++ b/README.md @@ -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.: @@ -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. diff --git a/test/python_bindings.cpp b/test/python_bindings.cpp index d7fe52a..0287770 100644 --- a/test/python_bindings.cpp +++ b/test/python_bindings.cpp @@ -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