summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre de Lacroix <pierre@pdelacroix.com>2020-10-24 03:17:31 +0000
committerPierre de Lacroix <pierre@pdelacroix.com>2020-10-24 03:17:31 +0000
commitedf8458ebefcc20fb58425ed3863693c31b9ff51 (patch)
tree0320d98deccc20718b15cb46535f5d1db6dc2222
parentMerge branch 'controller_tests' into 'master' (diff)
parentlittle edits on docs phrasing (diff)
Merge branch 'docs-review' into 'master'
Docs review See merge request kazarma/matrix_app_service.ex!7
-rw-r--r--lib/matrix_app_service.ex2
-rw-r--r--lib/matrix_app_service/adapter/room.ex3
-rw-r--r--lib/matrix_app_service/adapter/user.ex3
-rw-r--r--lib/matrix_app_service/client.ex3
4 files changed, 4 insertions, 7 deletions
diff --git a/lib/matrix_app_service.ex b/lib/matrix_app_service.ex
index 289d276..424ff2d 100644
--- a/lib/matrix_app_service.ex
+++ b/lib/matrix_app_service.ex
@@ -27,7 +27,7 @@ defmodule MatrixAppService do
### Write adapters
- Create one or multiple modules that implements the following modules:
+ Create one or multiple modules that implement the following modules:
`MatrixAppService.Adapter.Room`, `MatrixAppService.Adapter.User`,
`MatrixAppService.Adapter.Transaction`.
diff --git a/lib/matrix_app_service/adapter/room.ex b/lib/matrix_app_service/adapter/room.ex
index 1601094..14f04cb 100644
--- a/lib/matrix_app_service/adapter/room.ex
+++ b/lib/matrix_app_service/adapter/room.ex
@@ -1,7 +1,6 @@
defmodule MatrixAppService.Adapter.Room do
@moduledoc """
- Behaviour for a module that handles rooms that the application service has
- reserved.
+ Behaviour for a module that handles rooms reserved by the application service.
"""
@doc """
diff --git a/lib/matrix_app_service/adapter/user.ex b/lib/matrix_app_service/adapter/user.ex
index cd3c2aa..e397a11 100644
--- a/lib/matrix_app_service/adapter/user.ex
+++ b/lib/matrix_app_service/adapter/user.ex
@@ -1,7 +1,6 @@
defmodule MatrixAppService.Adapter.User do
@moduledoc """
- Behaviour for a module that handles users that the application service has
- reserved.
+ Behaviour for a module that handles rooms reserved by the application service.
"""
@doc """
diff --git a/lib/matrix_app_service/client.ex b/lib/matrix_app_service/client.ex
index c32cf00..42ef758 100644
--- a/lib/matrix_app_service/client.ex
+++ b/lib/matrix_app_service/client.ex
@@ -11,8 +11,7 @@ defmodule MatrixAppService.Client do
@doc """
Returns a client for the application service.
- The client gets its homeserver URL and access token from configuration, by
- default.
+ By default, the client gets its homeserver URL and access token from configuration.
Different options can be provided to override the defaults, those are:
* `:base_url`: homerver URL