Feed and Aggregator docs #137
Conversation
There was a problem hiding this comment.
This is a great improvement to the documentation, thanks!
Please re-fill your paragraphs... we want this to read reasonably well in raw text.
In the dev guide table of contents, I think feeds.rst should be after agents.rst.
Currently register_feeds is shown in the Agent example (agents.rst). It would be really nice to link to this section for more details.
| self.log.info("Subscribed to feed {}".format(feed_address)) | ||
| * - fresh_time | ||
| - Time (seconds) before feed is considered "stale", and is removed from | ||
| the HK status frame |
There was a problem hiding this comment.
Where are the agg_params actually decoded? What are the defaults? I assume this is in aggregator agent somewhere, and if so it would be good to link to it.
Also, this is now a superset of what is described in register_agent docstring. So it's possible we've got this information in 3 different places now...
There was a problem hiding this comment.
This is an argument to the Provider, so they're described in the Provider docstring.
docs/developer/feeds.rst
Outdated
| In the example above, the keys of the ``G3TimesampleMap`` will be | ||
| ``field_name_1`` and ``field_name_2``. | ||
| The ``block_name`` is only used internally and will not be written | ||
| to disk. |
There was a problem hiding this comment.
Perhaps add... "So field names must be unique within a single feed, and should be descriptive when block_name is not known" or similar?
|
Whoops... I didn't review aggregator.rst changes... will add that as a second review in a moment. |
|
Changes to aggregator.rst look fine. I've raised #138 because I think there are some other issues unrelated to the present PR. |
|
Alright! Implemented suggestions. It would be awesome if we could get this merged before the hack session tomorrow, so if there are any minor comments that you don't think should stop the merge feel free to create an issue or add them to Matthew's existing issue. |
| self.log.info("Subscribed to feed {}".format(feed_address)) | ||
| * - fresh_time | ||
| - Time (seconds) before feed is considered "stale", and is removed from | ||
| the HK status frame |
There was a problem hiding this comment.
This is an argument to the Provider, so they're described in the Provider docstring.
|
Latest round of comments addressed, will merge when tests are done. |
This PR updates the Feed and Aggregator docs to be up to date with the current version of ocs. Let me know if you have any suggestions!