rewrite documentation

This commit is contained in:
lunacb 2023-01-13 19:00:40 -05:00
parent 9780740ab9
commit fbe670651e
1 changed files with 18 additions and 22 deletions

View File

@ -82,7 +82,7 @@ def stringify_specific_pronoun(spec):
class PronounAdminCommand(Command):
"""
Configure the list of known server-wide pronouns.
Manages the list of known server-wide pronouns.
Usage:
@pronounadmin help
@ -90,15 +90,11 @@ class PronounAdminCommand(Command):
@pronounadmin spec <specific>
@pronounadmin unspec <specific>
On your character and server are stored character pronouns and specific
On each character and the server are stored character pronouns and specific
pronouns. The character pronouns specify what pronouns should actually be
used for your character, and the specific pronouns all the grammatical
forms of a pronoun so the character pronouns can be used in text
substitution.
The server already has some specific pronouns defined, so it's likely you
can just give your character pronouns and be done. Otherwise you'll have to
tell the server how to use your pronouns with the `spec` command.
used for your character, and the specific pronouns define all the
grammatical forms of a pronoun so the character pronouns can be used in
text substitution.
The specific format is: <subjective>,<objective>,<possessive>,<absolute>
subjective: *They* went to the store.
@ -173,7 +169,7 @@ class PronounAdminCommand(Command):
class SetPronounsCommand(Command):
"""
Sets your pronouns.
Manages your pronouns.
Usage:
@pronouns help
@ -183,15 +179,16 @@ class SetPronounsCommand(Command):
@pronouns spec <specific>
@pronouns unspec <specific>
On your character and server are stored character pronouns and specific
On each character and the server are stored character pronouns and specific
pronouns. The character pronouns specify what pronouns should actually be
used for your character, and the specific pronouns all the grammatical
forms of a pronoun so the character pronouns can be used in text
substitution.
used for your character, and the specific pronouns define all the
grammatical forms of a pronoun so the character pronouns can be used in
text substitution.
The server already has some specific pronouns defined, so it's likely you
can just give your character pronouns and be done. Otherwise you'll have to
tell the server how to use your pronouns with the `spec` command.
can just give your character pronouns and be done. If the server doesn't
know about your pronouns already then you'll have to tell the server how to
use them with the `spec` command.
The specific format is: <subjective>,<objective>,<possessive>,<absolute>
subjective: *They* went to the store.
@ -202,13 +199,12 @@ class SetPronounsCommand(Command):
The `set` command:
Sets your current character pronouns. Pronouns look the same as how you'd
write them in your bio on social media. They're separated by a slash ("/"),
like "she/they/it", or "he/him". Each pronoun should match to the
grammatical form of a specific pronoun. When multiple pronouns are given,
like both "she" and "they", a random one will be used in each text
substitution.
write them anywhere online. They're separated by a slash ("/"), like
"she/they/it", or "he/him". Each pronoun should match to the grammatical
form of a specific pronoun. When multiple pronouns are given, like both
"she" and "they", a random one will be used in each text substitution.
The `get` command gets your current configured pronouns.
The `get` command prints your current configured character pronouns.
The `list_known` command lists all specific pronouns known by the
server and specified for your acount.