Skip to content

Commit 12f0316

Browse files
christophfroehlichmergify[bot]
authored andcommitted
Fix rst errors (#447)
(cherry picked from commit 4218a6d)
1 parent aed2949 commit 12f0316

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

control_toolbox/CHANGELOG.rst

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

0 commit comments

Comments
 (0)