Skip to content

Commit e05497f

Browse files
committed
Fix smart quotes
1 parent 055f058 commit e05497f

39 files changed

+106
-106
lines changed

source/Concepts/Basic/About-Client-Libraries.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Language-specific functionality
109109
-------------------------------
110110

111111
Client library concepts that require language-specific features/properties are not implemented in the RCL but instead are implemented in each client library.
112-
For example, threading models used by spin functions will have implementations that are specific to the language of the client library.
112+
For example, threading models used by "spin" functions will have implementations that are specific to the language of the client library.
113113

114114
Demo
115115
----

source/Concepts/Intermediate/About-Executors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,4 +207,4 @@ Further information
207207
ROS Industrial Conference.
208208
Virtual event.
209209
16 December 2020.
210-
* Daniel Casini, Tobias Blass, Ingo Lütkebohle, and Björn Brandenburg: `Response-Time Analysis of ROS 2 Processing Chains under Reservation-Based Scheduling <https://drops.dagstuhl.de/opus/volltexte/2019/10743/pdf/LIPIcs-ECRTS-2019-6.pdf>`_, Proc. of 31st ECRTS 2019, Stuttgart, Germany, July 2019.
210+
* Daniel Casini, Tobias Blass, Ingo Lütkebohle, and Björn Brandenburg: `"Response-Time Analysis of ROS 2 Processing Chains under Reservation-Based Scheduling" <https://drops.dagstuhl.de/opus/volltexte/2019/10743/pdf/LIPIcs-ECRTS-2019-6.pdf>`_, Proc. of 31st ECRTS 2019, Stuttgart, Germany, July 2019.

source/Concepts/Intermediate/About-Quality-of-Service-Settings.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The base QoS profile currently includes settings for the following policies:
5858

5959
* Liveliness
6060

61-
* *Automatic*: the system will consider all of the nodes publishers to be alive for another "lease duration" when any one of its publishers has published a message.
61+
* *Automatic*: the system will consider all of the node's publishers to be alive for another "lease duration" when any one of its publishers has published a message.
6262
* *Manual by topic*: the system will consider the publisher to be alive for another "lease duration" if it manually asserts that it is still alive (via a call to the publisher API).
6363

6464
* Lease Duration
@@ -103,7 +103,7 @@ The currently defined QoS profiles are:
103103

104104
* Sensor data
105105

106-
For sensor data, in most cases its more important to receive readings in a timely fashion, rather than ensuring that all of them arrive.
106+
For sensor data, in most cases it's more important to receive readings in a timely fashion, rather than ensuring that all of them arrive.
107107
That is, developers want the latest samples as soon as they are captured, at the expense of maybe losing some.
108108
For that reason the sensor data profile uses best effort reliability and a smaller queue size.
109109

@@ -114,7 +114,7 @@ The currently defined QoS profiles are:
114114

115115
* System default
116116

117-
This uses the RMW implementations default values for all of the policies.
117+
This uses the RMW implementation's default values for all of the policies.
118118
Different RMW implementations may have different defaults.
119119

120120
`Click here <https://github.com/ros2/rmw/blob/{REPOS_FILE_BRANCH}/rmw/include/rmw/qos_profiles.h>`__ for the specific policies in use for the above profiles.

source/Contact.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ It's better to send all questions to `Robotics Stack Exchange <https://robotics.
2626
Contributing support
2727
^^^^^^^^^^^^^^^^^^^^
2828

29-
ROS 2 users come from a wide range of technical backgrounds, use a variety of different operating systems, and dont necessarily have any prior experience with ROS (1 or 2).
29+
ROS 2 users come from a wide range of technical backgrounds, use a variety of different operating systems, and don't necessarily have any prior experience with ROS (1 or 2).
3030
So, it's important for users with any amount of experience to contribute support.
3131

32-
If you see an issue on `Robotics Stack Exchange <https://robotics.stackexchange.com/>`__ that is similar to something youve run into yourself, please consider providing some pointers to what helped in your situation.
33-
Dont worry if you aren't sure if your response is correct.
32+
If you see an issue on `Robotics Stack Exchange <https://robotics.stackexchange.com/>`__ that is similar to something you've run into yourself, please consider providing some pointers to what helped in your situation.
33+
Don't worry if you aren't sure if your response is correct.
3434
Simply say so, and other community members will jump in if necessary.
3535

3636
Issues
@@ -95,7 +95,7 @@ To start a discussion with other ROS 2 community members, visit the official `RO
9595
Content on the Discourse should be high-level;
9696
it's not a place to get *questions* about code answered, but it would be suitable to start a conversation about best practices or improving standards.
9797

98-
Discussions about ROS 2 development and plans are happening on the `Next Generation ROS Discourse category <https://discourse.ros.org/c/ng-ros>`__.
98+
Discussions about ROS 2 development and plans are happening on the `"Next Generation ROS" Discourse category <https://discourse.ros.org/c/ng-ros>`__.
9999
Participating in these discussions is an important way to have a say on how different features of ROS 2 will work and be implemented.
100100

101101
The diverse community behind the ROS ecosystem is one of its greatest assets.

source/How-To-Guides/DDS-tuning.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Reduce the value, for example, to 3s, by running:
4646
4747
sudo sysctl net.ipv4.ipfrag_time=3
4848
49-
Reducing this parameters value also reduces the window of time where no fragments are received.
49+
Reducing this parameter's value also reduces the window of time where no fragments are received.
5050
The parameter is global for all incoming fragments, so the feasibility of reducing its value needs to be considered for every environment.
5151

5252
**Solution:** Increase the value of the ``ipfrag_high_thresh`` parameter.
@@ -60,7 +60,7 @@ Increase the value, for example, to 128MB, by running:
6060
6161
sudo sysctl net.ipv4.ipfrag_high_thresh=134217728 # (128 MB)
6262
63-
Significantly increasing this parameters value is an attempt to ensure that the buffer never becomes completely full.
63+
Significantly increasing this parameter's value is an attempt to ensure that the buffer never becomes completely full.
6464
However, the value would likely have to be significantly high to hold all data received during the time window of ``ipfrag_time``, assuming every UDP packet lacks one fragment.
6565

6666
**Issue:** Sending custom messages with large variable-sized arrays of non-primitive types causes high serialization/deserialization overhead and CPU load.
@@ -102,7 +102,7 @@ Cyclone DDS tuning
102102
**Issue:** Cyclone DDS is not delivering large messages reliably, despite using reliable settings and transferring over a wired network.
103103

104104
This issue should be `addressed soon <https://github.com/eclipse-cyclonedds/cyclonedds/issues/484>`_.
105-
Until then, weve come up with the following solution (debugged using `this test program <https://github.com/jacobperron/pc_pipe>`_):
105+
Until then, we've come up with the following solution (debugged using `this test program <https://github.com/jacobperron/pc_pipe>`_):
106106

107107
**Solution:** Increase the maximum Linux kernel receive buffer size and the minimum socket receive buffer size that Cyclone uses.
108108

@@ -158,12 +158,12 @@ By tuning ``net.core.rmem_max`` to 4MB in the Linux kernel, the QoS profile can
158158
This configuration has been proven to reliably deliver messages via SHMEM|UDPv4, and with just UDPv4 on a single machine.
159159
A multi-machine configuration was also tested with ``rmem_max`` at 4MB and at 20MB (two machines connected with 1Gbps ethernet), with no dropped messages and average message delivery times of 700ms and 371ms, respectively.
160160

161-
Without configuring the kernels ``rmem_max``, the same Connext QoS profile took up to 12 seconds for the data to be delivered.
161+
Without configuring the kernel's ``rmem_max``, the same Connext QoS profile took up to 12 seconds for the data to be delivered.
162162
However, it always at least managed to complete the delivery.
163163

164164
**Solution:** Use the `Connext QoS profile <https://github.com/jacobperron/pc_pipe/blob/master/etc/ROS2TEST_QOS_PROFILES.xml>`_ *without* adjusting ``rmem_max``.
165165

166-
The ROS2TEST_QOS_PROFILES.xml file was configured using RTIs documentation on `configuring flow controllers <https://community.rti.com/forum-topic/transfering-large-data-over-dds>`_.
166+
The ROS2TEST_QOS_PROFILES.xml file was configured using RTI's documentation on `configuring flow controllers <https://community.rti.com/forum-topic/transfering-large-data-over-dds>`_.
167167
It has slow, medium and fast flow controllers (seen in the Connext QoS profile link).
168168

169169
The medium flow controller produced the best results for our case.

source/How-To-Guides/Getting-Backtraces-in-ROS-2.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,14 @@ For GDB debugging, use it as follows:
134134
**Why Direct GDB Usage Can Be Tricky**
135135

136136
``--prefix`` will execute some bits of code before our ROS 2 command allowing us to insert some information.
137-
If you attempted to do ``gdb ex run --args ros2 run <pkg> <node>`` as analog to our example in the preliminaries, youd find that it couldnt find the ``ros2`` command.
137+
If you attempted to do ``gdb ex run --args ros2 run <pkg> <node>`` as analog to our example in the preliminaries, you'd find that it couldn't find the ``ros2`` command.
138138
Additionally, trying to source your workspace within GDB would fail for similar reasons.
139139
This is because GDB, when launched this way, lacks the environment setup that normally makes the ``ros2`` command available.
140140

141141
**Simplifying the Process with --prefix**
142142

143143
Rather than having to revert to finding the install path of the executable and typing it all out, we can instead use ``--prefix``.
144-
This allows us to use the same ``ros2 run`` syntax youre used to without having to worry about some of the GDB details.
144+
This allows us to use the same ``ros2 run`` syntax you're used to without having to worry about some of the GDB details.
145145

146146
.. code-block:: bash
147147
@@ -168,7 +168,7 @@ After you obtain a backtrace using GDB, here's how to interpret it:
168168

169169
**How to Debug once your Node Crashes**
170170

171-
Once your node crashes, youll see a prompt like below.
171+
Once your node crashes, you'll see a prompt like below.
172172
At this point you can get a backtrace.
173173

174174
.. code-block:: bash
@@ -219,7 +219,7 @@ From a Launch File
219219
Just as in our non-ROS example, we need to setup a GDB session before launching our ROS 2 launch file.
220220
While we could set this up through the commandline, we can instead make use of the same mechanics that we did in the ``ros2 run`` node example, now using a launch file.
221221

222-
In your launch file, find the node that youre interested in debugging.
222+
In your launch file, find the node that you're interested in debugging.
223223
For this section, we assume that your launch file contains only a single node (and potentially other information as well).
224224
The ``Node`` function used in the ``launch_ros`` package will take in a field prefix taking a list of prefix arguments.
225225
We will insert the GDB snippet here.

source/How-To-Guides/Overriding-QoS-Policies-For-Recording-And-Playback.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The YAML schema for the profile overrides is a dictionary of topic names with ke
4343
4444
If a policy value is not specified, the value will fallback to the default used by Ros2Bag.
4545
If you specify a Duration based policy such as ``deadline`` or ``lifespan``, you will need to specify both seconds and nanoseconds.
46-
Policy values are determined by the policys short keys which can be found using ``ros2topic`` verbs such as ``ros2 topic pub --help``.
46+
Policy values are determined by the policy's short keys which can be found using ``ros2topic`` verbs such as ``ros2 topic pub --help``.
4747
All values are replicated below for reference.
4848

4949
.. code-block:: yaml

source/How-To-Guides/Sync-Vs-Async.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ They can be made from anywhere without running the risk of blocking other ROS an
126126
An asynchronous client will immediately return ``future``, a value that indicates whether the call and response is finished (not the value of the response itself), after sending a request to a service.
127127
The returned ``future`` may be queried for a response at any time.
128128

129-
Since sending a request doesnt block anything, a loop can be used to both spin ``rclpy`` and check ``future`` in the same thread, for example:
129+
Since sending a request doesn't block anything, a loop can be used to both spin ``rclpy`` and check ``future`` in the same thread, for example:
130130

131131
.. code-block:: python
132132

source/How-To-Guides/Using-Python-Packages.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ In a new workspace, you can also quickly install all rosdep keys with:
3636
3737
rosdep install -yr ./path/to/your/workspace
3838
39-
If there arent currently ``rosdep`` keys for the package that you are interested in, it is possible to add them by following the `rosdep key contribution guide`_.
39+
If there aren't currently ``rosdep`` keys for the package that you are interested in, it is possible to add them by following the `rosdep key contribution guide`_.
4040

4141
To learn more about the ``rosdep`` tool and how it works, consult the `rosdep documentation`_.
4242

4343
Installing via a package manager
4444
--------------------------------
4545

46-
If you dont want to make a rosdep key, but the package is available in your system package manager (eg ``apt``), you can install and use the package that way:
46+
If you don't want to make a rosdep key, but the package is available in your system package manager (eg ``apt``), you can install and use the package that way:
4747

4848
.. code-block:: console
4949
@@ -78,7 +78,7 @@ Then setup your virtual environment:
7878
# Make a virtual env and activate it
7979
virtualenv -p python3 ./venv
8080
source ./venv/bin/activate
81-
# Make sure that colcon doesnt try to build the venv
81+
# Make sure that colcon doesn't try to build the venv
8282
touch ./venv/COLCON_IGNORE
8383
8484
Next, install the Python packages that you want in your virtual environment:

source/How-To-Guides/Using-callback-groups.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ in mind when working with callback groups.
9494
the edge of the system (user and sensor inputs etc).
9595
* Sometimes the callbacks are hidden and their presence may not be obvious
9696
from the user/developer API.
97-
This is the case especially with any kind of synchronous call to a
97+
This is the case especially with any kind of "synchronous" call to a
9898
service or an action (in rclpy).
9999
For example, the synchronous call ``Client.call(request)`` to a service
100100
adds a Future's done-callback that needs to be executed during the

0 commit comments

Comments
 (0)