PubSub: Document FlowControl settings#8293
Conversation
|
The generated docs look good to me. Nit: I see the word "Property" in front of each property in the generated docs. Not a big deal, but would be great if we can make it consistent with the rest of the documentation. |
|
The "property" prefix seems to be added to all namedtuple members, including those that do not have their docstrings modified, e.g. How are the current online docs generated and published anyway? Would a result be different if that was used instead of the local docs build? FWIW, I get the same result (the "property" prefix) if building the docs locally on the |
Closes #7043.
This PR makes sure that FlowControl settings are properly documented in the generated documentation.
How to test
Steps to perform:
(from inside the
pubsub/directory)FlowControl:Expected result:
FlowControlsettings have nice descriptions (as opposed to the current docs).