Fix motion_primitive_controller TOC in docs#2221
Fix motion_primitive_controller TOC in docs#2221SouriRishik wants to merge 7 commits intoros-controls:masterfrom
Conversation
github-actions
bot
requested review from
arne48,
bijoua29,
bmagyar,
erickisos and
saikishor
|
I think the PR referenced on the original issue removed the readme file. I think that may be the better option, if we are happy with the docs already in the main doc file. If we decide to stick with the readme, it should be in the package root. |
I agree, removing the README seems like the cleaner approach since the content is already included in the doc files. I'll update the PR to remove it instead. |
|
Also, is the doc8 pre-commit failure on rolling a known issue or something I need to fix on my end? |
|
the problem is mainly the heading level in the markdown file. have a look at the linked PR in the issue. the first of my commits should point you there. tests are not failing on master branch |
|
Done, removed the README.md and inlined the essential content directly into userdoc.rst with proper RST formatting. Please have a look. thank you! |
|
@bmagyar are the current changes good enough for solving the issue, if yes can we merge and close the PR? |
SouriRishik
force-pushed
the
fix/motion-primitive-controller-toc
branch
from
1b1e32a to
bf9c5a3
Compare
SouriRishik
force-pushed
the
fix/motion-primitive-controller-toc
branch
from
bf2f5f8 to
2942d73
Compare
SouriRishik
left a comment
SouriRishik
left a comment
There was a problem hiding this comment.
i think what i did changes in the readme and userdoc.rst were not relevant here so i just reverted those changes
|
@christophfroehlich i have made the required change and also the README and userdoc.rst is now untouched so that the information is as it is. |
|
Hi, following up on this PR. Please let me know if there are any further changes I should make. |
christophfroehlich
left a comment
christophfroehlich
left a comment
There was a problem hiding this comment.
What is the status of this PR? now there is only the resorting in controllers_index, have you forgotten to push something?
Hi, I thought changing the README and userdoc.rst was not necessary so I reverted that change which was done initally and only pushed resorting of controller_index. It got approval so I was just waiting until any other change was required |
|
However, if you want I can push the changes of README and userdoc.rst which will be under the path motion_primitives_controllers/doc and not motion_primitives_controllers like how it is right now |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2221 +/- ##
==========================================
- Coverage 84.68% 84.68% -0.01%
==========================================
Files 153 153
Lines 15318 15317 -1
Branches 1332 1332
==========================================
- Hits 12972 12971 -1
Misses 1858 1858
Partials 488 488
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
…m_trajectory_controller
4 participants
Fixes #2216
Changes
doc/controllers_index.rstmotion_primitives_controllers/doc/userdoc.rstREADME.mdanduserdoc.rstintomotion_primitives_controllers/doc/userdoc.rstandREADME.mdafter moveThis cherrypicks the fix from commit 7b2462a into master.
Checklist