aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/pythonapi.dox
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2018-09-10 17:16:24 -0700
committerMartin Braun <martin.braun@ettus.com>2018-09-10 17:16:51 -0700
commit7d0152ed1c14732a9f00467f47630403b8370cac (patch)
treec3bfc2bd185ec5fbec4fdd3f4a40470bfdc8b578 /host/docs/pythonapi.dox
parentad0bd0d9151b7ea86eadac45528cfbea16a01f37 (diff)
downloaduhd-7d0152ed1c14732a9f00467f47630403b8370cac.tar.gz
uhd-7d0152ed1c14732a9f00467f47630403b8370cac.tar.bz2
uhd-7d0152ed1c14732a9f00467f47630403b8370cac.zip
docs: Minor tweaks to the Python API manual page
Diffstat (limited to 'host/docs/pythonapi.dox')
-rw-r--r--host/docs/pythonapi.dox6
1 files changed, 4 insertions, 2 deletions
diff --git a/host/docs/pythonapi.dox b/host/docs/pythonapi.dox
index 590d976e0..2617c6141 100644
--- a/host/docs/pythonapi.dox
+++ b/host/docs/pythonapi.dox
@@ -14,7 +14,9 @@ Boost.Python from your Boost library). Make sure you have the CMake variable
The Python API supports both Python 2 and 3, but if you have both versions
installed, CMake might require some hints which version is the desired one.
-To force Python 3, UHD has a CMake variable `ENABLE_PYTHON3`
+To force Python 3, UHD has a CMake variable `ENABLE_PYTHON3`. If you set it,
+e.g., by running `cmake -DENABLE_PYTHON3=ON`, it will force the usage of
+Python 3.
\subsection python_install_windows Installing on Windows
@@ -58,7 +60,7 @@ usrp.set_rx_freq(100e6)
Not all API calls from the C++ API are also supported in the Python API, and
the Python API has some additional functions that are not available in C++, but
-for the most part, the `uhd::usrp::multi_usrp` API is identical.
+for the most part, the uhd::usrp::multi_usrp API is identical.
\section python_usage_oneoff One-off transmit/receive applications