Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Backend documentation #301

Merged
merged 5 commits into from
Jul 31, 2019
Merged

Add Backend documentation #301

merged 5 commits into from
Jul 31, 2019

Conversation

alecgibson
Copy link
Collaborator

This change adds Backend documentation to methods that provide
functionality not offered by a client.

This change adds `Backend` documentation to methods that provide
functionality not offered by a client.
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@coveralls
Copy link

coveralls commented Jul 4, 2019

Coverage Status

Coverage increased (+0.006%) to 95.954% when pulling 589924b on backend-docs into 0b65164 on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 95.948% when pulling 09b1cb3 on backend-docs into 0b65164 on master.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@alecgibson
Copy link
Collaborator Author

alecgibson commented Jul 10, 2019

We should add some stub documentation for Agent, mostly to document connection.agent to get a handle on an agent, and agent.custom for middleware things. We probably don't need to document the methods.

Agents and Connections are one-to-one. Agents represent the client's state on the server-side. On the server, the Agent has a direct reference to the Connection, and to the Backend (through a direct stream). A client-side Connection does not have a reference to an Agent.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Alec Gibson and others added 4 commits July 15, 2019 11:02
Clarify some of the new `Backend` documentation, and add documentation
for the `Backend` constructor, as well as some brief documentation on
the `Agent` class, accompanied by some rough authentication
documentation.
@ericyhwang ericyhwang merged commit f01cf0e into master Jul 31, 2019
@ericyhwang ericyhwang deleted the backend-docs branch July 31, 2019 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants