Skip to content

Commit f811894

Browse files
authored
Fix broken lists, standardize on "-" for lists (gamemanual0#254)
1 parent 8ea025a commit f811894

File tree

7 files changed

+27
-22
lines changed

7 files changed

+27
-22
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@ Building
2727
--------
2828

2929
How to check if the documentation is valid:
30-
* `make lint` (note: on Windows, `make winlint` will ignore CRLF line ending errors)
31-
* `make linkcheck`
30+
- `make lint` (note: on Windows, `make winlint` will ignore CRLF line ending errors)
31+
- `make linkcheck`
3232

3333
How to build the different versions of the documentation:
34-
* `make html`
35-
* `make latexpdf`
34+
- `make html`
35+
- `make latexpdf`
3636

3737
How to see the options for building:
38-
* `make help`
38+
- `make help`
3939

4040
How to develop the website:
41-
* Run `make autobuild`
42-
* This will set up a file watcher and build on file changes. A development server is served at `http://127.0.0.1:8000` by default. Go to your preferred browser and open that URL to view your local development version of gm0.
41+
- Run `make autobuild`
42+
- This will set up a file watcher and build on file changes. A development server is served at `http://127.0.0.1:8000` by default. Go to your preferred browser and open that URL to view your local development version of gm0.

source/docs/common-mechanisms/power-transmission/belt.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ When using timing belts, correct tension is very important. There are two main w
1212
Terms
1313
-----
1414

15-
- :term:`Pitch Diameter (PD) <Pitch Diameter>` refers to the imaginary circle which is traced by the middle of the belt as the pulley rotates. The outer edge of the circle is halfway between the outer face of the belt and the top face of the pulley groove. :math:`PD = (tooth * pitch)/\pi` * Pitch refers to the arc length between the centerlines of two adjacent pulley grooves. Pitch is simply the amount of pitch diameter in inches per tooth.
15+
- :term:`Pitch Diameter (PD) <Pitch Diameter>` refers to the imaginary circle which is traced by the middle of the belt as the pulley rotates. The outer edge of the circle is halfway between the outer face of the belt and the top face of the pulley groove. :math:`PD = (tooth * pitch)/\pi`
16+
17+
- Pitch refers to the arc length between the centerlines of two adjacent pulley grooves. Pitch is the amount of pitch diameter in inches per tooth.
1618
- Outside diameter (OD) is an imaginary circle which is traced by the top face of the grooves as the pulley rotates. **For pulleys, OD<PD.**
1719
- Pulley clearance diameter refers to the outer diameter of the pulley + belt when the belt is meshed properly to the pulley. The pulley clearance diameter is larger than both PD and OD and should be used to check for interference with other mechanisms.
1820

source/docs/common-mechanisms/power-transmission/chain.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,8 @@ Best practices for wrap
7777
Advantages
7878
----------
7979

80-
- **Chain can take a beating**. No matter what your application is, metal chain is usually up for the challenge. #25 chain can hold up to 930lbs before breaking, and there’s nothing you’ll do in FTC that will exert that force. (If your chain does break, it’s most likely due to a faulty Master Link or sprockets that are not correctly aligned.) * **Chain can be however long or short as you wish**.
81-
82-
If your ratio changes or your shafts move, it’s easy to adapt your chain run - just break the chain and put it back together at its new length. You can often do this without even removing the chain from your robot.
80+
- **Chain can take a beating**. No matter what your application is, metal chain is usually up for the challenge. #25 chain can hold up to 930lbs before breaking, and there’s nothing you’ll do in FTC that will exert that force. (If your chain does break, it’s most likely due to a faulty Master Link or sprockets that are not correctly aligned.)
81+
- **Chain can be however long or short as you wish**. If your ratio changes or your shafts move, it’s easy to adapt your chain run - just break the chain and put it back together at its new length. You can often do this without even removing the chain from your robot.
8382
- **Chain can be pretty precise**. When properly tensioned, roller chain doesn’t have very much slop. However, you really need to get your chain tension right to reduce slop, and you’ll probably want an adjustable tensioner for when the chain stretches. This can be done easily if using extrusion systems, as the sprocket can be adjusted for tension.
8483

8584
Disadvantages

source/docs/common-mechanisms/power-transmission/gears.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Bevel gears are a special type of gear that allows power transmission in two dif
1010
Terms
1111
-----
1212

13-
- Module refers to the amount of diametral pitch in millimeters per tooth. Simply, it refers to the tooth size. Typically, gears of the same material from the same manufacturer should have the same module. * Diametral pitch (DP) refers to the gear tooth size.
14-
15-
It is expressed as the number of teeth per inch of pitch diameter. Teeth size varies inversely with DP. * Pitch diameter (PD) refers to the diameter of the imaginary pitch circle that is drawn when the gear is meshed with the pitch circle of another gear. **For gears, PD < OD**.
13+
- Module refers to the amount of diametral pitch in millimeters per tooth. It refers to the tooth size. Typically, gears of the same material from the same manufacturer should have the same module.
14+
- Diametral pitch (DP) refers to the gear tooth size. It is expressed as the number of teeth per inch of pitch diameter. Teeth size varies inversely with DP.
15+
- Pitch diameter (PD) refers to the diameter of the imaginary pitch circle that is drawn when the gear is meshed with the pitch circle of another gear. **For gears, PD < OD**.
1616

1717
.. math::
1818

source/docs/custom-manufacturing/materials-guide.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,9 @@ Carbon Fiber
141141

142142
.. danger:: **Machining carbon fiber, like any fibrous substance, is a significant SAFETY HAZARD! Carbon fiber dust especially can cause cancer and is incredibly dangerous. DO NOT MACHINE/CUT carbon fiber unless you know what you are doing. When you do, make sure to either use machinery that is designed to cut carbon fiber, or cut in a well ventilated area with sufficient respiratory protection and running water over the carbon fiber.**
143143

144-
- Carbon fiber is one of the strongest materials for FTC use. For most teams, it is totally overkill, but it can be used in some specific applications. * Carbon fiber rods are used in custom linear slide extensions or multi-axis arms.
144+
- Carbon fiber is one of the strongest materials for FTC use. For most teams, it is totally overkill, but it can be used in some specific applications.
145+
146+
- Carbon fiber rods are used in custom linear slide extensions or multi-axis arms.
145147
- It is probably the most expensive material to purchase.
146148

147149
Cardboard

source/docs/software/options-for-programming.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Advantages
1717
- Easy to set up: requires a device (laptop, chromebook, tablet) and a phone in the Program & Manage screen
1818
- Programs can be saved directly to the phone
1919

20-
- Changes can be made quickly
20+
- Changes can be made quickly
2121
- Doesn’t require an external Wi-Fi connection
2222

2323
Disadvantages
@@ -101,7 +101,9 @@ Kotlin is a relatively new and rapidly growing programming language from Jetbrai
101101
Advantages
102102
~~~~~~~~~~
103103

104-
- Concise, readable, easy to edit code * Easy to write as it takes much less code to do the same thing
104+
- Concise, readable, easy to edit code
105+
106+
- Easy to write as it takes much less code to do the same thing
105107
- Both optional type inference and a stronger type system than Java
106108
- Null safety
107109
- Thread safety

source/docs/software/using-android-studio.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -340,8 +340,8 @@ Version control is an extremely useful tool. It allows for looking at (and rever
340340

341341
As far as version control systems go, we strongly recommend git. While a git tutorial is out of scope for |gm0|, here are some git resources:
342342

343-
* `The official git tutorial <https://git-scm.com/docs/gittutorial>`_
344-
* `GitHub's collection of git resources <https://docs.github.com/en/get-started/quickstart/set-up-git>`_
345-
* `GitHub's guide to installing git <https://github.com/git-guides/install-git>`_
346-
* `GitHub Desktop, a git GUI <https://desktop.github.com/>`_
347-
* `Android Studio's/IntelliJ's git integration documentation <https://www.jetbrains.com/help/idea/version-control-integration.html>`_
343+
- `The official git tutorial <https://git-scm.com/docs/gittutorial>`_
344+
- `GitHub's collection of git resources <https://docs.github.com/en/get-started/quickstart/set-up-git>`_
345+
- `GitHub's guide to installing git <https://github.com/git-guides/install-git>`_
346+
- `GitHub Desktop, a git GUI <https://desktop.github.com/>`_
347+
- `Android Studio's/IntelliJ's git integration documentation <https://www.jetbrains.com/help/idea/version-control-integration.html>`_

0 commit comments

Comments
 (0)