gall: clarify empty fact path only works in on-watch

This commit is contained in:
Tinnus Napbus 2023-07-01 19:33:02 +12:00
parent d9496f1f65
commit 5cd538040b

View File

@ -816,13 +816,14 @@ subscription content for all subscribers on a given path.
#### Structure #### Structure
```hoon ```hoon
[%fact (list path) =cage] [%fact paths=(list path) =cage]
``` ```
`(list path)` is a list of the paths to send the update on. If no path is `paths` is a list of the subscription paths to send the update on. In
given, then the update is only given to the program that instigated the `+on-watch` alone, if no path is given, then the update is given
request. Typical use of this mode is in `+on-watch` to give an initial update exclusively to the source of the `%watch` request. This is useful for
to a new subscriber to get them up to date. giving initial state to new subscribers. In other contexts, one or more
subscription paths should be provided.
`cage` is a cage of the subscription update. `cage` is a cage of the subscription update.