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

ws-docs: Extend WebSocket documentation #16118

Closed
wants to merge 2 commits into from

Conversation

viscruocco
Copy link
Contributor

Tried to clean up and extend the documentation on the WebSocket-API a little.

There are some other information missing from the docs in my opinion, but since they are not relevant for my use case I wasn't able to investigate further. So see this as a suggestion for an TODO list of doc improvements if you will:

  • How does CURLWS_RAW_MODE affect curl_ws_meta/curl_ws_recv/curl_ws_send?
  • Can curl_ws_send be used if CURLOPT_WRITEFUNCTION was set instead of CURLOPT_CONNECT_ONLY?

@bagder
Copy link
Member

bagder commented Jan 28, 2025

curl_ws_recv.md:43:1:ERROR: un-escaped < or > used

I believe this is a bug in cd2nroff. It should not require escaped lt/gt in quoted sections. Allow me to do a PR for that...

@bagder
Copy link
Member

bagder commented Jan 28, 2025

If you rebase on top of master and force-push, I think that warning should be gone now.

@viscruocco viscruocco force-pushed the websocket-documentation branch 2 times, most recently from 48bdc29 to e95681b Compare January 29, 2025 08:19
@viscruocco viscruocco force-pushed the websocket-documentation branch from e95681b to 8ecf12b Compare January 29, 2025 08:25
@viscruocco viscruocco force-pushed the websocket-documentation branch from 6366eab to 3f9f707 Compare January 30, 2025 08:14
@viscruocco
Copy link
Contributor Author

I believe this is a bug in cd2nroff. It should not require escaped lt/gt in quoted sections. Allow me to do a PR for that...

Thanks a lot for the prompt fix and feedback so far! :)

@viscruocco viscruocco requested a review from bagder January 30, 2025 08:24
@bagder bagder closed this in dc3252b Feb 3, 2025
@bagder
Copy link
Member

bagder commented Feb 3, 2025

Thanks!

@viscruocco viscruocco deleted the websocket-documentation branch February 4, 2025 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants