Skip to content

Commit

Permalink
Fix writing of PolyScope
Browse files Browse the repository at this point in the history
  • Loading branch information
urfeex committed Dec 16, 2024
1 parent d2b4900 commit 6ced4e9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 5 additions & 4 deletions doc/polyscope_compatibility.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
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
below, but that might either require some manual modifications or not using a subset of features.
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
Expand All @@ -25,3 +25,4 @@ your robot.
- `polyscope_compat_break_1 <https://github.com/UniversalRobots/Universal_Robots_Client_Library/tree/polyscope_compat_break_1>`_
- `tcp_offset in RTDE interface <https://github.com/UniversalRobots/Universal_Robots_Client_Library/pull/110>`_

.. |polyscope| replace:: PolyScope

0 comments on commit 6ced4e9

Please sign in to comment.