Merge pull request #236 from simonsobs/koopman/matched-client-updates

MatchedClient Tests, Rename, and Documentation Updates
simonsobs · Nov 8, 2021 · 58f7e3f · 58f7e3f
2 parents 7681985 + 1804040
commit 58f7e3f
Show file tree

Hide file tree

Showing 19 changed files with 795 additions and 351 deletions.
diff --git a/docs/agents/fake_data.rst b/docs/agents/fake_data.rst
@@ -1,3 +1,5 @@
+.. _fake_data_agent:
+
 ===============
 Fake Data Agent
 ===============

diff --git a/docs/agents/registry.rst b/docs/agents/registry.rst
@@ -55,9 +55,9 @@ viewed by checking the session variable of the main process.
 For instance, the following code will print agent's that have been on the system
 since the registry started running::
 
-    from ocs.matched_client import MatchedClient
+    from ocs.ocs_client import OCSClient
 
-    registry_client = MatchedClient('registry')
+    registry_client = OCSClient('registry')
     status, msg, session = registry_client.main.status()
 
     print(session['data'])

diff --git a/docs/api.rst b/docs/api.rst
@@ -63,6 +63,16 @@ ocs.ocs_agent
 
 .. _ocs_feed_api:
 
+ocs.ocs_client
+------------------
+
+.. automodule:: ocs.ocs_client
+    :members:
+    :exclude-members: _opname_to_attr, _humanized_time
+    :undoc-members:
+    :show-inheritance:
+    :private-members:
+
 ocs.ocs_feed
 ------------
 

diff --git a/docs/developer/architecture.rst b/docs/developer/architecture.rst
@@ -14,6 +14,8 @@ arbitrary RPC and Pub/Sub events, the OCS imposes a very limited set
 of allowed interactions between the devices on the system.  The OCS
 requires a WAMP router, such as crossbar.io.
 
+.. _agent_ops:
+
 Agent Operations: Tasks and Processes
 -------------------------------------