From f8ccbb7896ea682b7b0b638c1d7d5542768c1f21 Mon Sep 17 00:00:00 2001 From: David Lechner Date: Tue, 11 Feb 2020 12:59:13 -0600 Subject: [PATCH] api/messaging: rename ev3messaging module to messaging --- .../_images/{ev3messaging.svg => messaging.svg} | 0 doc/api/index.rst | 4 ++-- doc/api/{ev3_mailboxes.rst => mailboxes.rst} | 10 +++++----- doc/api/{ev3messaging.rst => messaging.rst} | 17 +++++++++-------- pybricks/{ev3messaging.py => messaging.py} | 0 5 files changed, 16 insertions(+), 15 deletions(-) rename doc/api/_images/{ev3messaging.svg => messaging.svg} (100%) rename doc/api/{ev3_mailboxes.rst => mailboxes.rst} (92%) rename doc/api/{ev3messaging.rst => messaging.rst} (55%) rename pybricks/{ev3messaging.py => messaging.py} (100%) diff --git a/doc/api/_images/ev3messaging.svg b/doc/api/_images/messaging.svg similarity index 100% rename from doc/api/_images/ev3messaging.svg rename to doc/api/_images/messaging.svg diff --git a/doc/api/index.rst b/doc/api/index.rst index 9ab9815..fd88a13 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -29,7 +29,7 @@ Intro tools robotics media - ev3messaging + messaging .. toctree:: :maxdepth: 1 @@ -38,5 +38,5 @@ Intro signaltypes motors - ev3_mailboxes + mailboxes .. frames diff --git a/doc/api/ev3_mailboxes.rst b/doc/api/mailboxes.rst similarity index 92% rename from doc/api/ev3_mailboxes.rst rename to doc/api/mailboxes.rst index 590950c..24b71fc 100644 --- a/doc/api/ev3_mailboxes.rst +++ b/doc/api/mailboxes.rst @@ -1,5 +1,5 @@ -EV3 Mailboxes -============= +Mailboxes +========= TODO: introduction... messages are sent immediately, received messages are held in mailbox for getting later. @@ -48,9 +48,9 @@ program is that client program has connect block. Server is always running. TODO: show equivalent blocks -- :class:`pybricks.ev3messaging.LogicMailbox` -- :class:`pybricks.ev3messaging.NumericMailbox` -- :class:`pybricks.ev3messaging.TextMailbox` +- :class:`pybricks.messaging.LogicMailbox` +- :class:`pybricks.messaging.NumericMailbox` +- :class:`pybricks.messaging.TextMailbox` .. rubric:: More than two bricks diff --git a/doc/api/ev3messaging.rst b/doc/api/messaging.rst similarity index 55% rename from doc/api/ev3messaging.rst rename to doc/api/messaging.rst index 2f08ea8..d3eb783 100644 --- a/doc/api/ev3messaging.rst +++ b/doc/api/messaging.rst @@ -1,18 +1,18 @@ -:mod:`ev3messaging ` -- EV3 Messaging -============================================================ +:mod:`messaging ` -- Messaging +================================================== -.. automodule:: pybricks.ev3messaging +.. automodule:: pybricks.messaging :no-members: -.. currentmodule:: pybricks.ev3messaging +.. currentmodule:: pybricks.messaging -Introductory text. An example network is shown in :numref:`fig_ev3messaging`. +Introductory text. An example network is shown in :numref:`fig_messaging`. -.. _fig_ev3messaging: +.. _fig_messaging: -.. figure:: images/ev3messaging_label.png +.. figure:: images/messaging_label.png :width: 90 % - :alt: ev3messaging + :alt: messaging :align: center An example network with one server and two clients. @@ -25,6 +25,7 @@ Connections .. autoclass:: BluetoothMailboxClient + Mailboxes --------- diff --git a/pybricks/ev3messaging.py b/pybricks/messaging.py similarity index 100% rename from pybricks/ev3messaging.py rename to pybricks/messaging.py