GUI Issue #75 - Update to docs regarding inbound stream port inputs

NASA-AMMOS · Sep 4, 2019 · dc12eaa · dc12eaa
1 parent 9490466
commit dc12eaa
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/doc/source/server_architecture.rst b/doc/source/server_architecture.rst
@@ -43,13 +43,13 @@ Example configuration:
 Streams
 ^^^^^^^
 - Streams must be listed under either **inbound-streams** or **outbound-streams**, and must have a **name**.
-- Inbound streams can have an integer port or inbound streams as their **input**. Inbound streams can have multiple inputs.
+- Inbound streams can have an integer port or inbound streams as their **input**. Inbound streams can have multiple inputs. A port input should always be listed as the first input to an inbound stream.
 - Outbound streams can have plugins or outbound streams as their **input**. Outbound streams can have multiple inputs.
 
    - Outbound streams also have the option to **output** to an integer port (see :ref:`example config below <Stream_config>`).
 
 - Streams can have any number of **handlers**. A stream passes each received *packet* through its handlers in order and publishes the result.
-- There are several stream classes that inherit from the base stream class. These child classes exist for handling the input and output of streams differently based on whether the inputs/output are ports or other streams and plugins. The appropriate stream type will be instantiated based on whether the stream is an inbound or outbound stream and based on the inputs/output specified in the stream's configs. If the input type of an inbound stream is an integer, it will be assumed to be a port. If it is a string, it will be assumed to be another stream name or plugin. A port input should always be listed as the first input to an inbound stream. Only outbound streams can have an output, and the output must be a port, not another stream or plugin.
+- There are several stream classes that inherit from the base stream class. These child classes exist for handling the input and output of streams differently based on whether the inputs/output are ports or other streams and plugins. The appropriate stream type will be instantiated based on whether the stream is an inbound or outbound stream and based on the inputs/output specified in the stream's configs. If the input type of an inbound stream is an integer, it will be assumed to be a port. If it is a string, it will be assumed to be another stream name or plugin. Only outbound streams can have an output, and the output must be a port, not another stream or plugin.
 
 .. _Stream_config:
 Example configuration: