Skip to content

Commit 52ee607

Browse files
cclaussHwurzburg
authored andcommitted
Enable sphinx-lint rule dangling-hyphen
1 parent 0348e88 commit 52ee607

4 files changed

Lines changed: 10 additions & 11 deletions

File tree

.pre-commit-config.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ repos:
2222
- id: sphinx-lint
2323
args:
2424
- --disable=backtick-before-role
25-
- --disable=dangling-hyphen
2625
- --disable=horizontal-tab
2726
- --disable=hyperlink-reference-missing-backtick
2827
- --disable=missing-final-newline

copter/source/docs/traditional-helicopter-first-flight-tests.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Hover Trim
3030

3131
Trimming the helicopter in pitch and roll axes is an important step to keep the
3232
aircraft from drifting in modes like Stabilize and Althold. The trim attitude
33-
in the roll axis is affected by the tail rotor thrust. All conventional single-
34-
rotor helicopters with a torque-compensating tail rotor hover either right skid
33+
in the roll axis is affected by the tail rotor thrust. All conventional single-rotor
34+
helicopters with a torque-compensating tail rotor hover either right skid
3535
low or left skid low, depending on which way the main rotor turns. The
3636
ArduCopter software has a parameter, :ref:`ATC_HOVR_ROL_TRM<ATC_HOVR_ROL_TRM>`, to compensate for this phenomenon.
3737
Dual rotor helicopters have counter rotating rotor systems which mostly cancel the torque. For these aircraft,

dev/source/docs/sitl-with-airsim.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ A demo of AirSim running with ArduPilot SITL
2222
.. youtube:: ElFAqtpEfKo
2323
:width: 100%
2424

25-
A list of topics for easier navigation in the page-
25+
A list of topics for easier navigation in the page:
2626

2727
#. :ref:`Install AirSim <sitl-with-airsim-install>`
2828

@@ -144,7 +144,7 @@ The file is in usual JSON format. On the first startup, AirSim would create ``se
144144
Launch Copter SITL
145145
++++++++++++++++++
146146

147-
For using ArduCopter, the settings are as follows-
147+
For using ArduCopter, the settings are as follows:
148148

149149
::
150150

@@ -193,7 +193,7 @@ You can restart by just pressing the Play button and then start the ArduPilot si
193193
Launch Rover SITL
194194
+++++++++++++++++
195195

196-
``settings.json`` for using ArduRover-
196+
``settings.json`` for using ArduRover:
197197

198198
::
199199

@@ -511,15 +511,15 @@ A ROS wrapper has also been added. See `airsim_ros_pkgs <https://github.com/micr
511511
Run on different machines
512512
+++++++++++++++++++++++++
513513

514-
#. Change the following in the ``settings.json`` file-
514+
#. Change the following in the ``settings.json`` file:
515515

516516
#. ``UdpIp`` to the IP address of the machine running ArduPilot (Can be found using ``ipconfig`` on Windows, ``ifconfig`` on Linux.)
517517
#. ``LocalHostIp`` to the IP address of the current machine which is running AirSim, specific to the network adapter being used such as Ethernet or WiFi. Can be set to ``0.0.0.0`` to receive messages on all networks
518518

519519

520520
#. Use ``-A`` argument in ``sim_vehicle.py`` (passes the arguments following it to the SITL instance), followed by ``--sim-address`` to specify Airsim's IP address
521521

522-
An example-
522+
An example:
523523

524524
::
525525

@@ -541,7 +541,7 @@ Using different ports
541541
- ``--sim-port-in`` should be equal to sensor port i.e. port specified in ``UdpPort``
542542
- ``--sim-port-out`` should be equal to motor control port i.e. port specified in ``ControlPort``
543543

544-
Similar to changing the IP address as mentioned above, use ``-A`` to pass the arguments to the SITL instance. Example-
544+
Similar to changing the IP address as mentioned above, use ``-A`` to pass the arguments to the SITL instance. Example:
545545

546546
::
547547

dev/source/docs/submitting-patches-back-to-master.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Preparing commits
3939
describe what it does. Be prepared to explain/defend the importance of
4040
any new comments to reviewers, and defer to their judgement to resolve
4141
any disagreement over a comment's value. Comments should not explain
42-
"what" code does, they explain "why" (or perhaps "how" in a clever-but-
43-
difficult implementation).
42+
"what" code does, they explain "why" (or perhaps "how" in a
43+
clever-but-difficult implementation).
4444

4545
- Resist moving code within files/libraries. Preserving the in-file
4646
location of code is preferred over rearranging the file(s) to improve

0 commit comments

Comments
 (0)