Skip to content

Commit

Permalink
[docs] Fix broken Codox links in wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Sep 5, 2023
1 parent e68be16 commit f25e176
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions wiki/0-Breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This upgrade involves **4 possible breaking changes** detailed below:

**Change 1/4**

The default `wrap-recv-evs?` option has changed in [`make-channel-socket-client!`](http://ptaoussanis.github.io/sente/taoensso.sente.html#var-make-channel-socket-client.21).
The default `wrap-recv-evs?` option has changed in [`make-channel-socket-client!`](http://taoensso.github.io/sente/taoensso.sente.html#var-make-channel-socket-client.21).

- **Old** default behaviour: events from server are **wrapped** with `[:chsk/recv <event>]`
- **New** default behaviour: events from server are **unwrapped**
Expand All @@ -23,11 +23,11 @@ More info at: [#319](../issues/319)

**Change 2/4**

The default [`*write-legacy-pack-format?*`](http://ptaoussanis.github.io/sente/taoensso.sente.html#var-*write-legacy-pack-format.3F*) value has changed from `true` to `false`.
The default [`*write-legacy-pack-format?*`](http://taoensso.github.io/sente/taoensso.sente.html#var-*write-legacy-pack-format.3F*) value has changed from `true` to `false`.

This change is only relevant for the small minority of folks that use a custom (non-standard) [`IPacker`](https://github.com/ptaoussanis/sente/blob/f69a5df6d1f3e88d66a148c74e1b5a9084c9c0b9/src/taoensso/sente/interfaces.cljc#L55).

If you do use a custom (non-standard) `IPacker`, please see the [relevant docstring](http://ptaoussanis.github.io/sente/taoensso.sente.html#var-*write-legacy-pack-format.3F*) for details.
If you do use a custom (non-standard) `IPacker`, please see the [relevant docstring](http://taoensso.github.io/sente/taoensso.sente.html#var-*write-legacy-pack-format.3F*) for details.

**Motivation for change**: the new default value is part of a phased transition to a new Sente message format that better supports non-string (e.g. binary) payloads.

Expand Down
2 changes: 1 addition & 1 deletion wiki/1-Getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ You'll setup something similar on the client side:

After setup, the client will automatically initiate a WebSocket or repeating long-polling connection to your server. Client<->server events are now ready to transmit over the `ch-chsk` channel.

**Last step**: you'll want to **hook your own event handlers up to this channel**. Please see one of the [example projects](./3-Example-projects) and/or [API docs](http://ptaoussanis.github.io/sente/) for details.
**Last step**: you'll want to **hook your own event handlers up to this channel**. Please see one of the [example projects](./3-Example-projects) and/or [API docs](http://taoensso.github.io/sente/) for details.

## Client-side API

Expand Down
4 changes: 2 additions & 2 deletions wiki/2-Client-and-user-ids.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Sente uses two types of connection identifiers: **client-ids** and **user-ids**.

A client-id is a unique identifier for one particular Sente client: i.e. one particular invocation of `make-channel-socket-client!`. This typically means **one particular browser tab** on one device.

By default, clients generate their own random (uuid) client-id. You can override this in your call to [`make-channel-socket-client!`](http://ptaoussanis.github.io/sente/taoensso.sente.html#var-make-channel-socket-client.21).
By default, clients generate their own random (uuid) client-id. You can override this in your call to [`make-channel-socket-client!`](http://taoensso.github.io/sente/taoensso.sente.html#var-make-channel-socket-client.21).

Note:
1. Each client chooses its _own_ client-id with no input from the server.
Expand All @@ -21,7 +21,7 @@ It is determined _server-side_ as a configurable function of each connecting cha

Typically, you'll configure Sente's user-id to be something like your application's username: if Alice logs into your application with 6 different browser tabs over 3 different devices - she'll have 6 client-ids associated with her user-id. And when your server sends an event "to Alice", it'll be delivered to all 6 of her connected clients.

By default, Sente will use `(fn user-id [ring-req] (get-in ring-req [:session :uid]))` as your user-id function. You can override this in your call to [`make-channel-socket-server!`](http://ptaoussanis.github.io/sente/taoensso.sente.html#var-make-channel-socket-server.21).
By default, Sente will use `(fn user-id [ring-req] (get-in ring-req [:session :uid]))` as your user-id function. You can override this in your call to [`make-channel-socket-server!`](http://taoensso.github.io/sente/taoensso.sente.html#var-make-channel-socket-server.21).

Note:

Expand Down

0 comments on commit f25e176

Please sign in to comment.