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.

Sign up for GitHub

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

Jump to bottom

Update documentation to async code (#331) #332

Merged
merged 2 commits into from
Oct 16, 2023
Merged

Update documentation to async code (#331) #332

merged 2 commits into from
Oct 16, 2023

Conversation

tobiasah
Copy link
Contributor

This commit updates the documentation to the latest changes added with pycapnp 2.0.0

@tobiasah
Copy link
Contributor Author

tobiasah commented Oct 12, 2023 •
edited
Loading

This is just a draft and not finished yet.
I just wanted to share the progress early in case someone wants to give feedback and avoid duplicate work.
I finished the essential adaption to the new changes. Let me know if something needs to be added or clarified. I would love to restructure and extend the documentation further in the future a bit more. But IMHO, for the 2.0.0, the current state is sufficient.

LasseBlaauwbroek
LasseBlaauwbroek reviewed Oct 12, 2023
View reviewed changes
Copy link
Contributor

@LasseBlaauwbroek LasseBlaauwbroek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks good to me.

docs/capnp.rst Show resolved Hide resolved
docs/quickstart.rst Outdated Show resolved Hide resolved
@tobiasah tobiasah changed the title DRAFT: Update documentation to async code (#331) Update documentation to async code (#331) Oct 13, 2023
LasseBlaauwbroek
LasseBlaauwbroek reviewed Oct 13, 2023
View reviewed changes
Copy link
Contributor

@LasseBlaauwbroek LasseBlaauwbroek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing that should be documented at some point is the ability to send and receive messages over a socket in async mode, like in this example: https://github.com/capnproto/pycapnp/blob/master/examples/async_socket_message_client.py

docs/quickstart.rst Outdated Show resolved Hide resolved
docs/quickstart.rst Outdated Show resolved Hide resolved
@tobiasah
Copy link
Contributor Author

One thing that should be documented at some point is the ability to send and receive messages over a socket in async mode, like in this example: https://github.com/capnproto/pycapnp/blob/master/examples/async_socket_message_client.py

Right. I missed that. I added a small section for both the read-from and write-to a socket in the quickstart (4fcf2b4).
In general, I think the documentation could be improved with a better structure, but I first want to get out the beta before tackling that.

@tobiasah
Update documentation to async code (capnproto#331)
fb85ffd 
This commit updates the documentation to the latest changes added
with pycapnp 2.0.0.

* Remove non existing classes/functions from the reference documentation
* Adapt the quickstart to the latest changes. Mainly to new rpc handling,
  that now exlusively is done through asyncio.
@tobiasah
DOC: Add section about send and receive messages over a socket
c8793ee 
Since capnproto#313 it is possible to read and write messages over a socket.
This commit adds a small section for read and write in the quickstart.
@haata haata merged commit 302a96d into capnproto:master Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LasseBlaauwbroek LasseBlaauwbroek LasseBlaauwbroek left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tobiasah @LasseBlaauwbroek @haata