Skip to content

Commit 8f3086b

Browse files
authored
Minor improvements to README.md (#766)
1 parent e233623 commit 8f3086b

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This repository is currently built automatically by two systems. Github Actions
2525

2626
## Build Locally
2727

28-
If you want to test the tutorials by generating the html pages locally on your machine, you can use the ``build_locally`` script.
28+
If you want to test the tutorials by generating the HTML pages locally on your machine, you can use the ``build_locally`` script.
2929
Run in the root of the moveit_tutorials package:
3030

3131
export ROS_DISTRO=kinetic # 16.04
@@ -39,20 +39,20 @@ The local website ``<LOCAL_PACKAGE_PATH>/build/html/index.html`` should automati
3939

4040
## ROS Build Farm Deployment
4141

42-
For deploying documentation changes to the web, [Section 3 of rosdoc_lite wiki](http://wiki.ros.org/rosdoc_lite) says that "rosdoc_lite is automatically run for packages in repositories that have rosinstall files listed in the rosdistro repository." This is done about once every 24 hours, [overnight](http://wiki.ros.org/rosdistro/Tutorials/Indexing%20Your%20ROS%20Repository%20for%20Documentation%20Generation).
42+
For deploying documentation changes to the web, [Section 3 of the rosdoc_lite wiki](http://wiki.ros.org/rosdoc_lite) says that "rosdoc_lite is automatically run for packages in repositories that have rosinstall files listed in the rosdistro repository." This is done about once every 24 hours, [overnight](http://wiki.ros.org/rosdistro/Tutorials/Indexing%20Your%20ROS%20Repository%20for%20Documentation%20Generation).
4343

4444
## Contributing
4545

46-
We rely on the community to keep these tutorials up to date and bug free. If you find an issue with the tutorials please [open an issue on GitHub](https://github.com/ros-planning/moveit_tutorials/issues/new) or open a PR with proposed changes.
46+
We rely on the community to keep these tutorials up-to-date and bug-free. If you find an issue with the tutorials please [open an issue on GitHub](https://github.com/ros-planning/moveit_tutorials/issues/new) or open a PR with the proposed changes.
4747

4848
### Formatting and Style
4949

5050
**Code Formatting**
5151

52-
* These tutorials use the same [style guidelines](http://moveit.ros.org/documentation/contributing/code/) as the MoveIt project. When modifying or adding to these tutorials, it is required that code is auto formatted using [clang-format](http://moveit.ros.org/documentation/contributing/code/). To check and apply our style guidelines we use [pre-commit](https://pre-commit.com/).
52+
* These tutorials use the same [style guidelines](http://moveit.ros.org/documentation/contributing/code/) as the MoveIt project. When modifying or adding to these tutorials, it is required that code is auto-formatted using [clang-format](http://moveit.ros.org/documentation/contributing/code/). To check and apply the style guidelines we use [pre-commit](https://pre-commit.com/).
5353
* Tutorials should exemplify best coding practices. If a contribution wouldn't pass review in the MoveIt project, then it shouldn't pass review in the tutorials.
5454
* Relevant code should be included and explained using the ``.. tutorial-formatter::`` tag.
55-
* Irrelevant code should be excluded from the generated html using the ``BEGIN_TUTORIAL``, ``END_TUTORIAL``, ``BEGIN_SUB_TUTORIAL``, and ``END_SUB_TUTORIAL`` tags.
55+
* Irrelevant code should be excluded from the generated HTML using the ``BEGIN_TUTORIAL``, ``END_TUTORIAL``, ``BEGIN_SUB_TUTORIAL``, and ``END_SUB_TUTORIAL`` tags.
5656
* Whenever possible, links should be created using the ``extlinks`` dictionary defined in ``conf.py``.
5757
* All demo code should be runnable from within the ``moveit_tutorials`` package.
5858
* Python code should be run using ``rosrun``.
@@ -61,19 +61,19 @@ We rely on the community to keep these tutorials up to date and bug free. If you
6161

6262
* Each tutorial should be focused on teaching the user one feature or interface within MoveIt.
6363
* Tutorials should flow from show to tell with videos and demos at the beginning followed by explanations.
64-
* New tutorials should match the formatting, style and flow of existing tutorials whenever possible.
64+
* New tutorials should match the formatting, style, and flow of existing tutorials whenever possible.
6565

6666
**pre-commit**
6767

6868
pre-commit is a tool that is used in ``moveit_tutorials`` to check and apply style guidelines automatically. To install pre-commit into your system:
6969

7070
pip3 install pre-commit
7171

72-
In you catkin workspace, under ``moveit_tutorials`` directory you can install the git hooks like this:
72+
In your catkin workspace, under the``moveit_tutorials`` directory you can install the git hooks like this:
7373

7474
cd $CATKIN_WS/src/moveit_tutorials && pre-commit install
7575

76-
With this pre-commit will automatically run and check a list of styling including clang-format, end of files and trailing whitespaces whenever you run ``git commit``. To run pre-commit any time other than ``git commit`` you can use the following command:
76+
With this pre-commit will automatically run and check a list of styling including clang-format, end of files, and trailing whitespaces whenever you run ``git commit``. To run a pre-commit at any time other than ``git commit`` you can use the following command:
7777

7878
cd $CATKIN_WS/src/moveit_tutorials && pre-commit run -a
7979

@@ -122,21 +122,21 @@ This assumes that `filename.png` is in the same folder as the source `.rst` file
122122

123123
[External Documentation](https://sublime-and-sphinx-guide.readthedocs.io/en/latest/images.html)
124124

125-
Do **not** include animated gifs as the file format leads to very large files. Use a video format like `webm` and see the section on local video below.
125+
Do **not** include animated gifs as the file format leads to very large files. Use a video format like `webm` and see the section on the local video below.
126126

127127
#### YouTube and other External Video
128-
You can embed video with raw html, like in this example from the Pick and Place Tutorial.
128+
You can embed video with raw HTML, like in this example from the Pick and Place Tutorial.
129129
```
130130
.. raw:: html
131131
132132
<div style="position: relative; padding-bottom: 5%; height: 0; overflow: hidden; max-width: 100%; height: auto;">
133133
<iframe width="700px" height="400px" src="https://www.youtube.com/embed/QBJPxx_63Bs?rel=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
134134
</div>
135135
```
136-
This includes [Youtube's suggested embed html](https://support.google.com/youtube/answer/171780?hl=en).
136+
This includes [Youtube's suggested embed code](https://support.google.com/youtube/answer/171780?hl=en).
137137

138138
#### Local Video
139-
To embed a video that is included in this repository, you also will use raw html, like this example from the Quickstart in RViz tutorial.
139+
To embed a video that is included in this repository, you also will use raw HTML, like this example from the Quickstart in RViz tutorial.
140140

141141
```
142142
.. raw:: html

0 commit comments

Comments
 (0)