Commit edf8458e authored by Pierre de Lacroix's avatar Pierre de Lacroix
Browse files

Merge branch 'docs-review' into 'master'

Docs review

See merge request !7
parents 4c0fb5e1 56130349
Pipeline #207071114 passed with stages
in 5 minutes and 23 seconds
......@@ -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`.
......
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 """
......
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 """
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment