diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2023-03-21 16:33:44 +0100 |
|---|---|---|
| committer | Jeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com> | 2023-09-25 09:43:37 +0200 |
| commit | 713f93c46065a8af3509311e428c0ea7db9da5c8 (patch) | |
| tree | 2ba905ff9112fe6d9bbb3e6811e04aa0e5204b0b | |
| parent | 9e13bcf816eb77814c18870dc97e6ec185682beb (diff) | |
API Overview: Typos
| -rw-r--r-- | docs/src/api/overview/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/src/api/overview/README.md b/docs/src/api/overview/README.md index 3cb9d30..73ea215 100644 --- a/docs/src/api/overview/README.md +++ b/docs/src/api/overview/README.md @@ -34,7 +34,7 @@ This section describes a few types that are either used as arguments or return v ### JSON -The message passing between language X and Go is done using JSON. This means that every type that we mention here is converted to JSON. For a list of public types that are returned and their JSON representation see: <https://github.com/eduvpn/eduvpn-common/blob/v2/types/>. So for example, if we say that we return `types.server.Expiry` (meaning the `Expiry` struct defined in the [types/server](https://github.com/eduvpn/eduvpn-common/blob/v2/types/server/server.go), we will return the following json representation: +The message passing between language X and Go is done using JSON. This means that every type that we mention here is converted to JSON. For a list of public types that are returned and their JSON representation see: <https://github.com/eduvpn/eduvpn-common/blob/v2/types/>. So for example, if we say that we return `types.server.Expiry` (meaning the `Expiry` struct defined in the [types/server](https://github.com/eduvpn/eduvpn-common/blob/v2/types/server/server.go)), we will return the following json representation: ```json { @@ -337,7 +337,7 @@ Return type: - An error ### Deregistering -When the client is done, e.g. on application close, it can call the `deregister function` to save the internal state to disk and afterwards empty out this state. This can also be used to re-register, but this is probably not something you have to do. +When the client is done, e.g. on application close, it can call the `deregister` function to save the internal state to disk and afterwards empty out this state. This can also be used to re-register, but this is probably not something you have to do. Arguments: - None |