Skip to content

Commit 4218a6d

Browse files
Fix rst errors (#447)
1 parent 608f56a commit 4218a6d

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

control_toolbox/CHANGELOG.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -357,9 +357,9 @@ Changelog for package control_toolbox
357357
* catkinizing, could still be cleaned up
358358
* Fixing doc errors in PID
359359
* Changing @ commands to \ commands
360-
* Enforcing i_min_ <= 0 and i_max_ >= 0 in integral bound parameters, reducing duplicated code
360+
* Enforcing ``i_min_`` <= 0 and ``i_max_`` >= 0 in integral bound parameters, reducing duplicated code
361361
* Merge pull request `#14 <https://github.com/ros-controls/control_toolbox/issues/14>`_ from bobholmberg/fix-PID-unbounded-i_error
362-
Using zero i_gain_ to turn off integral control did unsavory things.
362+
Using zero ``i_gain_`` to turn off integral control did unsavory things.
363363
* Adding alternative name for new pid command computation API
364364
* Fixing merge error
365365
* Merge branch 'fix-pid-backwards-compatibility' into fix-PID-unbounded-i_error
@@ -376,13 +376,13 @@ Changelog for package control_toolbox
376376
* Specifying div-by-zero test, adding other integral term tests
377377
* Merge branch 'test-bad-integral-bounds' into fix-PID-unbounded-i_error
378378
* Adding test to expose Pid class zero-division vulnerability
379-
* If the user did not want integral control and set i_gain_ to zero,
380-
then dividing by i_gain_ would set i_error_ to NaN. This is not
381-
desired. Instead, replace the use of division to create i_term
382-
with direct integration of i_term_.
383-
Replace private member i_error_ with i_term_.
384-
In getCurrentPIDErrors() create & return i_error_ with the same old meaning and units.
385-
NOTE: i_error_ is not needed internally anywhere else.
379+
* If the user did not want integral control and set ``i_gain_`` to zero,
380+
then dividing by ``i_gain_`` would set ``i_error_`` to NaN. This is not
381+
desired. Instead, replace the use of division to create ``i_term``
382+
with direct integration of ``i_term_``.
383+
Replace private member ``i_error_`` with ``i_term_``.
384+
In ``getCurrentPIDErrors()`` create & return ``i_error_`` with the same old meaning and units.
385+
NOTE: ``i_error_`` is not needed internally anywhere else.
386386
* Cleaning up documentation, making argument names in function declaration match those in the implementation
387387
* adding doxygen deprecation flags
388388
* Fixing documentation

0 commit comments

Comments
 (0)