Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs: match main-branch documentation #951

Open
wants to merge 1 commit into
base: humble
Choose a base branch
from

Conversation

AvuPaul
Copy link

@AvuPaul AvuPaul commented Aug 25, 2024

Description

Section 3 of this page was not clear and probably to most unusable. On the main-branch the correct text and formatting was available

main: https://moveit.picknik.ai/main/doc/tutorials/visualizing_in_rviz/visualizing_in_rviz.html
humble: https://moveit.picknik.ai/main/doc/tutorials/visualizing_in_rviz/visualizing_in_rviz.html

Checklist

  • Required by CI: Code is auto formatted using clang-format
  • While waiting for someone to review your request, please consider reviewing another open pull request to support the maintainers

Section 3 of this page was not clear and probably to most unusable. On the main-branch the correct text and formatting was available
Copy link
Contributor

@sea-bass sea-bass left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indentation in the code blocks seems to not be consistent with main. Have you tried building the docs locally to see if this renders okay?

If that works, plus one small comment inline, should be good.


After each one of these changes, you should rebuild your workspace to make sure you don't have any syntax errors.
After making these changes, rebuild your workspace to make sure you dont have any syntax errors.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the ' character changed, please make sure you use the regular one instead of the backtick.:

  don't  # yes
  don`t  # no

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants