From 6ced4e9ba42b6fd3695b678b49acf9e90e850f94 Mon Sep 17 00:00:00 2001 From: Felix Exner Date: Mon, 16 Dec 2024 17:09:12 +0100 Subject: [PATCH] Fix writing of PolyScope --- doc/installation.rst | 2 +- doc/polyscope_compatibility.rst | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/installation.rst b/doc/installation.rst index b6e60759..848f77c9 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -67,7 +67,7 @@ When you want to use this library in other cmake projects, make sure to As a minimal example, take the following “project”: As a minimal executable, we'll create a client for the dashboard server and ask for the -PolyscopeVersion. +PolyScope version. .. note:: This will not work on PolyScope X versions, as the dashboard server is not available there. diff --git a/doc/polyscope_compatibility.rst b/doc/polyscope_compatibility.rst index 65bc23dd..567507d2 100644 --- a/doc/polyscope_compatibility.rst +++ b/doc/polyscope_compatibility.rst @@ -1,7 +1,7 @@ -Polyscope version compatibility +|polyscope| version compatibility =============================== -The table below shows breaking changes in the library compared to Polyscope versions. Compatibility +The table below shows breaking changes in the library compared to |polyscope| versions. Compatibility is listed for CB3 robots (versions 3.x.y) and e-Series robots (versions 5.x.y) respectively. It might be possible to use the library in a more recent version than the compatible versions listed @@ -9,14 +9,14 @@ below, but that might either require some manual modifications or not using a su For that reason the breaking changes are also listed inside the table. Please note that choosing a higher library version than recommended happens on your own risk and will not be supported. -If your Polyscope version is less than the minimum required version for the latest library version, +If your |polyscope| version is less than the minimum required version for the latest library version, we suggest to upgrade your robot's software. Please refer to the robot's user manual how to update your robot. .. list-table:: :header-rows: 1 - * - Polyscope version + * - |polyscope| version - Max. version - Max. tag - Breaking changes @@ -25,3 +25,4 @@ your robot. - `polyscope_compat_break_1 `_ - `tcp_offset in RTDE interface `_ +.. |polyscope| replace:: PolyScope