liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(docs): consistency: use 'boolean' everywhere instead of 'bool'

Browse Source
This commit is contained in:
spiral 2022-01-11 09:57:47 -05:00
parent 56c3d6057e
commit 8aa2b0b7aa
No known key found for this signature in database
GPG Key ID: A6059F0CA0E1BD31
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/content/api/legacy.md
View File

@ -49,7 +49,7 @@ A `?` after the column type indicates a nullable parameter (value can be cleared
| prefix | string? | Yes | **Deprecated.** Use `proxy_tags` instead. |
| suffix | string? | Yes | **Deprecated.** Use `proxy_tags` instead. |
| proxy_tags | ProxyTag[] | Yes (entire array) | An array of ProxyTag (see below) objects, each representing a single prefix/suffix pair. |
| keep_proxy | bool | Yes | Whether to display a member's proxy tags in the proxied message. |
| keep_proxy | boolean | Yes | Whether to display a member's proxy tags in the proxied message. |
| created | datetime | No | |
| privacy | string? | Yes | **Deprecated.** Use `<subject>_privacy` and `visibility` fields. |
| visibility | string? | Yes | Patching with `private` will set it to private; `public` or `null` will set it to public. |

6
docs/content/api/models.md
View File

@ -106,9 +106,9 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|timezone|string|defaults to `UTC`|
|pings_enabled|boolean|
|latch_timeout|int?|
|member_default_private*|bool|whether members created through the bot have privacy settings set to private by default|
|group_default_private*|bool|whether groups created through the bot have privacy settings set to private by default|
|show_private_info|bool|whether the bot shows the system's own private information without a `-private` flag|
|member_default_private*|boolean|whether members created through the bot have privacy settings set to private by default|
|group_default_private*|boolean|whether groups created through the bot have privacy settings set to private by default|
|show_private_info|boolean|whether the bot shows the system's own private information without a `-private` flag|
|member_limit|int|read-only, defaults to 1000|
|group_limit|int|read-only, defaults to 250|