← index #7149Issue #4450
Related · high · value 0.192
QUERY · ISSUE

docs: document uwebsocket module

openby dpgeorgeopened 2021-04-23updated 2024-03-18
docs

It needs basic docs to explain that it's mainly used for webrepl and does not have a full websocket implementation.

See related: #2410, #4450.

CANDIDATE · ISSUE

RFC: Rename "websocket" to "uwebsocket"

closedby pfalconopened 2019-01-31updated 2021-04-23

This is similar to https://github.com/micropython/micropython/issues/4370, submitting a new ticket as that one has PR and hopefully can be closed soon.

Naming "websocket" module as such was pretty brave, as it's of course the default name for a module dealing with Websockets, and there should be tons of "websocket" modules around. MicroPython's module is pretty specific as it implements only data transfer handling, leaving handshake part to Python code.

"websocket" module was also not documented and described as highly experimental, with only intended user is webrepl subsys. So, I think here we can just rename it to "uwebsocket", without weak links, and at least include it in the list of modules in the docs, if not describe its API completely.

Keyboard

j / / n
next pair
k / / p
previous pair
1 / / h
show query pane
2 / / l
show candidate pane
c
copy suggested comment
r
toggle reasoning
g i
go to index
?
show this help
esc
close overlays

press ? or esc to close

copied