improve userlog docu

Co-authored-by: Martin <github@diemattels.at>
owncloud · Jun 29, 2023 · 137b98f · 137b98f
1 parent 3e5a3a0
commit 137b98f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/services/userlog/README.md b/services/userlog/README.md
@@ -32,7 +32,7 @@ The `userlog` service provides an API to retrieve configured events. For now, th
 
 ## Subscribing
 
-Additionaly to the oc10 API the `userlog` service also provides an `/sse` (Server-Sent Events) endpoint to be informed by the server when an event happens. See [here](https://medium.com/yemeksepeti-teknoloji/what-is-server-sent-events-sse-and-how-to-implement-it-904938bffd73) for example for simple introduction to server sent events. The `sse` endpoint will respect language changes of the user without needing to reconnect.
+Additionaly to the oc10 API, the `userlog` service also provides an `/sse` (Server-Sent Events) endpoint to be informed by the server when an event happens. See [What is Server-Sent Events](https://medium.com/yemeksepeti-teknoloji/what-is-server-sent-events-sse-and-how-to-implement-it-904938bffd73) for a simple introduction and examples to server sent events. The `sse` endpoint will respect language changes of the user without needing to reconnect.
 
 ## Deleting
 

diff --git a/services/userlog/pkg/config/config.go b/services/userlog/pkg/config/config.go
@@ -28,7 +28,7 @@ type Config struct {
 	Events            Events      `yaml:"events"`
 	Persistence       Persistence `yaml:"persistence"`
 
-	DisableSSE bool `yaml:"disable_sse" env:"USERLOG_DISABLE_SSE" desc:"Disables server-sent events. Clients will no longer be able to connect to the sse endpoint."`
+	DisableSSE bool `yaml:"disable_sse" env:"USERLOG_DISABLE_SSE" desc:"Disables server-sent events (sse). When disabled, clients will no longer be able to connect to the sse endpoint."`
 
 	Context context.Context `yaml:"-"`
 }