diff --git a/doc/api/ev3devices.rst b/doc/api/ev3devices.rst index 7d90fee..fa441ba 100644 --- a/doc/api/ev3devices.rst +++ b/doc/api/ev3devices.rst @@ -15,6 +15,7 @@ Motors EV3-compatible motors. The arrows indicate the default positive direction. .. autoclass:: pybricks.ev3devices.Motor + :noindex: :no-members: .. rubric:: Measuring diff --git a/doc/api/parameters.rst b/doc/api/parameters.rst index 23422f7..5a00dbe 100644 --- a/doc/api/parameters.rst +++ b/doc/api/parameters.rst @@ -35,7 +35,7 @@ The following table show how each stop type adds an extra level of resistance to motion. In these examples, ``m`` is a - ``Motor`` and + :class:`Motor ` and and ``d`` is a :class:`DriveBase `. The examples also show how running at zero speed compares to these stop types. diff --git a/doc/api/pupdevices/motor.rst b/doc/api/pupdevices/motor.rst index 8e8e67a..a1d1405 100644 --- a/doc/api/pupdevices/motor.rst +++ b/doc/api/pupdevices/motor.rst @@ -13,7 +13,6 @@ Motors with Rotation Sensors directions of built-in motors. .. autoclass:: pybricks.pupdevices.Motor - :noindex: :no-members: .. rubric:: Measuring diff --git a/doc/api/signaltypes.rst b/doc/api/signaltypes.rst index 521bf57..d19168b 100644 --- a/doc/api/signaltypes.rst +++ b/doc/api/signaltypes.rst @@ -29,7 +29,7 @@ All angles are measured in degrees (deg). One full rotation corresponds to 360 degrees. For example, the angle values of a ``Motor`` or -the :meth:`GyroSensor <.ev3devices.GyroSensor.angle>` are expressed in degrees. +the ``GyroSensor`` are expressed in degrees. .. _speed: @@ -40,7 +40,7 @@ Rotational speed, or *angular velocity* describes how fast something rotates, expressed as the number of degrees per second (deg/s). For example, the rotational speed values of a ``Motor`` or the -:meth:`GyroSensor <.ev3devices.GyroSensor.speed>` are expressed in degrees +``GyroSensor`` are expressed in degrees per second. While we recommend working with degrees per second in your programs, you can @@ -78,8 +78,8 @@ distance: mm ------------- Distances are expressed in millimeters (mm) whenever possible. -For example, the distance value of the :meth:`UltrasonicSensor -<.ev3devices.UltrasonicSensor.distance>` is measured in millimeters. +For example, the distance value of the ``UltrasonicSensor`` +is measured in millimeters. While we recommend working with millimeters in your programs, you can use the following table to convert between commonly used units. @@ -158,8 +158,8 @@ Some distance measurements do not provide an accurate value with a specific unit, but they range from very close (0%) to very far (100%). These are referred to as relative distances. -For example, the distance value of the :meth:`InfraredSensor -<.ev3devices.InfraredSensor.distance>` is a relative distance. +For example, the distance value of the ``InfraredSensor`` +is a relative distance. .. _brightness: diff --git a/doc/api/start_ev3/start_ev3_upgrade.rst b/doc/api/start_ev3/start_ev3_upgrade.rst index 0d05097..2ff1d99 100644 --- a/doc/api/start_ev3/start_ev3_upgrade.rst +++ b/doc/api/start_ev3/start_ev3_upgrade.rst @@ -204,7 +204,7 @@ complete details of all methods and arguments. Other internal changes to existing features ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- Most methods of the :class:`Motor() ` class now +- Most methods of the ``Motor`` class now have ``Stop.HOLD`` as the default instead of ``Stop.COAST``. This improves accuracy in most applications. You can still select ``Stop.COAST`` if you like.