Skip to content

Commit

Permalink
Add link to Python Alert (#2915)
Browse files Browse the repository at this point in the history
Fixes #2758
Fix style guide python intersphinx syntax
  • Loading branch information
sciencewhiz authored Jan 5, 2025
1 parent 5743804 commit 64120ce
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion source/docs/contributing/frc-docs/style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Hi there, `this is a link`_ and it's pretty cool!
Links to the RobotPY API documentation should use the following sphinx [python syntax](https://www.sphinx-doc.org/en/master/usage/domains/python.html) (example linking to the DriverStation API docs).

```ReST
:external:py:class:`Python <robotpy:wpilib.DriverStation>`
:py:class:`Python <robotpy:wpilib.DriverStation>`
```

This expands to be equivalent to:
Expand Down
2 changes: 1 addition & 1 deletion source/docs/software/telemetry/persistent-alerts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Robots encounter a variety of fault conditions: disconnected sensors/motors, invalid mechanism states, initialization failures, etc. While the FRC Driver Station provides a :ref:`console interface <docs/software/driverstation/driver-station:Messages Tab>` for instantaneous alerts, the risk of missing important messages makes it poorly suited to communicate faults that persist over time.

Instead, the ``Alert`` class ([Java](https://github.wpilib.org/allwpilib/docs/release/java/edu/wpi/first/wpilibj/Alert.html), [C++](https://github.wpilib.org/allwpilib/docs/release/cpp/classfrc_1_1_alert.html)) can be used for managing persistent alerts published via Network Tables. Alerts are assigned a priority (*error*, *warning*, or *info*) and can be *activated* or *deactivated* in robot code. The set of active alerts can be displayed on a dashboard, as shown below in Shuffleboard.
Instead, the ``Alert`` class ([Java](https://github.wpilib.org/allwpilib/docs/release/java/edu/wpi/first/wpilibj/Alert.html), [C++](https://github.wpilib.org/allwpilib/docs/release/cpp/classfrc_1_1_alert.html), :py:class:`Python <robotpy:wpilib.Alert>`) can be used for managing persistent alerts published via Network Tables. Alerts are assigned a priority (*error*, *warning*, or *info*) and can be *activated* or *deactivated* in robot code. The set of active alerts can be displayed on a dashboard, as shown below in Shuffleboard.

.. image:: images/alerts.png
:alt: A screenshot of the alerts widget in Shuffleboard, with several active alerts.
Expand Down

0 comments on commit 64120ce

Please sign in to comment.