Skip to content

Commit

Permalink
Fix doc build
Browse files Browse the repository at this point in the history
  • Loading branch information
taras committed Aug 15, 2024
1 parent 4c36fec commit 9da05e5
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ build:

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
configuration: docs/source/conf.py

# Optional but recommended, declare the Python requirements required
# to build your documentation
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ Echo server
print("New client connected")
def on_ws_frame(self, transport: WSTransport, frame: WSFrame):
transport.send(frame.opcode, frame.get_payload_as_bytes())
if frame.opcode == WSMsgType.CLOSE:
transport.send(frame.msg_type, frame.get_payload_as_bytes())
if frame.msg_type == WSMsgType.CLOSE:
transport.disconnect()
async def main():
Expand Down
4 changes: 2 additions & 2 deletions picows/picows.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ cdef class WSFrame:
Internally WSFrame just points to a chunk of memory in the receiving buffer without copying or owning memory.\n
.. DANGER::
Only use WSFrame object during :any:`WSListener.on_ws_frame` callback. WSFrame objects are essentially just
pointers to the underlying receiving buffer. After :any:`WSListener.on_ws_frame` is completed the buffer
pointers to the underlying receiving buffer. After :any:`WSListener.on_ws_frame` has completed the buffer
will be reused for the new incoming data.
In order to actually copy payload use one of the `get_*` methods.
Expand Down Expand Up @@ -153,7 +153,7 @@ cdef class WSFrame:
.. DANGER::
Returned memoryview does NOT own the underlying memory.
The content will be invalidated after :any:`WSListener.on_ws_frame` is complete.
The content will be invalidated after :any:`WSListener.on_ws_frame` has completed.
Please process payload or copy it as soon as possible.
"""
return PyMemoryView_FromMemory(self.payload_ptr, <Py_ssize_t>self.payload_size, PyBUF_READ)
Expand Down

0 comments on commit 9da05e5

Please sign in to comment.