diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2022-11-01 15:29:38 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-11-02 19:01:18 +0100 |
| commit | f7c611ab71d292d64a6d4db8db8e36aaf0e2330b (patch) | |
| tree | 2521af5ba64af64c9f5c667b419ff66fc1324f60 /modules/websocket | |
| parent | 39cece382d1c0f9f89eaa469a93497c50b516686 (diff) | |
Style: Misc docs and comment style and language fixes
- Removed empty paragraphs in XML.
- Consistently use bold style for "Example:", on a new line.
- Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`).
- Fix invalid usage of backticks for inline code in BBCode.
- Fix some American/British English spelling inconsistencies.
- Other minor fixes spotted along the way, including typo fixes with codespell.
- Don't specify `@GlobalScope` for `enum` and `constant`.
Diffstat (limited to 'modules/websocket')
| -rw-r--r-- | modules/websocket/doc_classes/WebSocketPeer.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/modules/websocket/doc_classes/WebSocketPeer.xml b/modules/websocket/doc_classes/WebSocketPeer.xml index fe0aae412e..41d166a0f5 100644 --- a/modules/websocket/doc_classes/WebSocketPeer.xml +++ b/modules/websocket/doc_classes/WebSocketPeer.xml @@ -133,7 +133,7 @@ <return type="int" enum="Error" /> <param index="0" name="message" type="String" /> <description> - Sends the given [param message] using WebSocket text mode. Perfer this method over [method PacketPeer.put_packet] when interacting with third-party text-based API (e.g. when using [JSON] formatted messages). + Sends the given [param message] using WebSocket text mode. Prefer this method over [method PacketPeer.put_packet] when interacting with third-party text-based API (e.g. when using [JSON] formatted messages). </description> </method> <method name="set_no_delay"> |