Update documentation post-PR #298 merge #388
Conversation
Clarify and expand migration instructions now that pull request ros-controls#298 has been merged, ensuring users know how to adjust their configurations accordingly.
|
@christophfroehlich I’ve created a PR to update the documentation, but I’m not sure if there are other repositories or files I need to update. Can you help me with that? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## ros2-master #388 +/- ##
============================================
Coverage 76.72% 76.72%
============================================
Files 30 30
Lines 1744 1744
Branches 107 107
============================================
Hits 1338 1338
Misses 346 346
Partials 60 60
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
I suggest that you add the documentation here Add a new section for the PID, copy basis information from the docstring and add your antiwindup description from the other PR there. |
Adds a comprehensive PID section to control_toolbox.md, covering the standard PID equation, descriptions of proportional, integral, and derivative gains, output limits, detailed explanations of anti-windup strategies (back-calculation and conditional integration) with update rules and default values, and a C++ usage example.
Clarify and expand migration instructions now that pull request ros-controls#298 has been merged, ensuring users know how to adjust their configurations accordingly.
Done! I changed it from draft to open. If there is still documentation to add, I’ll add more commits. |
github-actions
bot
requested review from
anfemosa,
aprotyas,
ARK3r,
destogl,
livanov93,
moriarty and
saikishor
Adds a comprehensive PID section to control_toolbox.md, covering the standard PID equation, descriptions of proportional, integral, and derivative gains, output limits, detailed explanations of anti-windup strategies (back-calculation and conditional integration) with update rules and default values, and a C++ usage example.
Documentation PR post-PR #298 merge