Commit graph

36 commits

Author SHA1 Message Date
Tobias Ahrens
302a96d84d
Update documentation to async code (#331) (#332)
* Update documentation to async code (#331)

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.

* DOC: Add section about send and receive messages over a socket

Since #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.
2023-10-16 11:05:27 -07:00
André Cruz
1b19b6db13
Prevent race condition in example code (#305)
The example async server code uses timeouts around read() operations.
However, this has a race condition where data can be read, the timeout
fires, and the data is lost.

These timeouts are not really needed in this example code, so I removed
them to prevent people from having strange issues with lost messages
and undefined RPC behavior when using the example code.
2023-01-08 22:29:23 -08:00
rmelick
6d531f0575 Update documentation about from_bytes to use context manager. #287 2022-07-12 09:19:54 -07:00
Jacob Alexander
5e8ccba536
Updating docs for v1.0.0b2
- Full cleanup of all the docs
- General sphinx housekeeping
- Updated all the old/bad links
- More reliable tests
- Updated Changelog
- Removed dead/deprecated code
- Added documentation generation test
2020-06-14 17:05:45 -07:00
Fabian Hachenberg
fedbd877ff
fixed wrong rst syntax 2020-02-13 22:47:30 +01:00
Fabian Hachenberg
8cef29f3ed
Fixed link markup, refined link label 2020-02-13 22:46:31 +01:00
Fabian Hachenberg
e914dc8251
Refined description of what happens when you call init multiple times
The original note was misleading in that it implied an actual memory leakage (in the common sense of the term). This is not the case though since the memory is left as dead space in the message but is always correctly freed upon freeing the arena.
2020-02-13 22:43:54 +01:00
Constantine Vetoshev
f703a7f099 Update segment (de)serialization documentation. 2016-06-24 13:28:35 -07:00
Constantine Vetoshev
42ed1e819f Update documentation to cover segments. 2016-06-23 14:42:45 -07:00
Jakub Stasiak
b4ee5039fc Fix schema example in the documentation 2014-04-07 00:36:06 +01:00
Jason Paryani
46fb701899 Small typo fixes in quickstart docs 2014-02-27 18:16:20 -08:00
Jason Paryani
7a4ae96c81 Add documentation for using dicts as typeless structs 2014-01-14 09:05:20 -08:00
Jason Paryani
72ccb5c1b6 Touching up docs a bit 2013-12-18 12:01:27 -08:00
Jason Paryani
f9bb12bff9 Update RPC with simpler methods for connecting 2013-12-12 11:55:50 -08:00
Jason Paryani
110a7c7806 Add restore to docs 2013-12-12 00:20:59 -08:00
Jason Paryani
de7545d285 Small typo fixes in docs 2013-12-12 00:12:15 -08:00
Jason Paryani
adf8e92003 Update docs for RPC 2013-12-12 00:02:44 -08:00
Jason Paryani
618097dec1 Add ability for passing AnyPointer to restore in RPCClient 2013-12-09 19:18:54 -08:00
Jason Paryani
a57a99f7fc Update docs 2013-09-04 21:53:05 -07:00
Jason Paryani
a4eec2ef08 Fix even more typos in docs 2013-09-04 12:01:28 -07:00
Jason Paryani
2dc67e6f73 Fix typo in docs 2013-09-04 11:57:58 -07:00
Jason Paryani
f51c34361d Update docs for v0.3.0 release of C++ api 2013-09-04 10:38:00 -07:00
Jason Paryani
e80e002a6c Fix some docs 2013-09-03 22:10:37 -07:00
Jason Paryani
eec8cbe05c Add dictionary methods to docs 2013-09-03 01:24:16 -07:00
Jason Paryani
38cef54ddc Update docs with new import method 2013-09-03 01:16:48 -07:00
Jason Paryani
1317527893 Change naming for functions to conform to PEP 8. Also deprecate old
read/write api.
2013-09-01 20:10:57 -07:00
Jason Paryani
6fcdf841e4 Update preferred method for reading/writing messages from files 2013-09-01 02:13:19 -07:00
Jason Paryani
f6f02a5ca5 Change all references to old project name 2013-09-01 01:15:31 -07:00
Jason Paryani
3772198e82 Fix up docs for new C++ RC 2013-08-30 23:13:20 -07:00
Jason Paryani
2bfc0e0d9a update docs for constants 2013-08-25 17:51:23 -07:00
Jason Paryani
2fd40f528e Update docs 2013-08-21 17:46:50 -07:00
Jason Paryani
79653ca260 Add doc about abasolute paths for load function 2013-08-21 17:18:02 -07:00
Jason Paryani
934a204ea5 Fixed up the docs a bit with sugesstions from Kenton 2013-08-20 00:58:34 -07:00
Jason Paryani
4373ecc50b Fix spacing typo 2013-08-18 23:49:07 -07:00
Jason Paryani
6c3041a9c6 Fix up docs 2013-08-18 22:43:40 -07:00
Jason Paryani
22b3199335 Initial commit of docs 2013-08-18 21:49:12 -07:00