Doc'd the debugger #33
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| The three arguments are the same arguments one would pass to receptor itself. | ||
| data_path: points to the data path where the manifest and message store will reside |
Contributor
There was a problem hiding this comment.
I still don't entirely get what this is. Is this a filesystem path encoded as a string?
Contributor
|
Run |
| listen: defines the url that the receptor server will start on | ||
| node_id: declares the name of the node, or the node_id | ||
| The API exposes 4 endpoints: |
Contributor
There was a problem hiding this comment.
Which API exposes four endpoints? The receptor process' socket address as defined by the listen parameter?
|
|
||
| class DiagNode: | ||
| """ | ||
| A DiagNode takes a datapath, a node_id and a listener port and spins up an instance of a |
Contributor
There was a problem hiding this comment.
Can this docstring start by stating what a DiagNode is, before progressing to the parameters it takes? Something like:
"""A wrapper around a receptor process that's configured to provide debugging info.
Accepts the following parameters:
...
"""
Or whatever is appropriate. I see some references to web.run_app and flask, so apparently there's a web app somewhere?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Doc'd the debugger