Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-11-23 20:49:43 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #20 from Mkaysi/they

Browse Source 
Use gender neutral pronouns
This commit is contained in:
Valentin Lorentz 2014-08-28 14:09:30 +02:00
commit 320d16e191
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
develop/style.rst
View File

@ -125,13 +125,13 @@ Style Guidelines
doing isn't important for the user to pay attention to. A user who likes doing isn't important for the user to pay attention to. A user who likes
to keep up with things should enjoy watching our logging at the INFO to keep up with things should enjoy watching our logging at the INFO
level; it shouldn't be too low-level, but it should give enough level; it shouldn't be too low-level, but it should give enough
information that it keeps him relatively interested at peak times. information that it keeps them relatively interested at peak times.
* WARNING: Appropriate to tell a user when we're doing something that he * WARNING: Appropriate to tell a user when we're doing something that they
really ought to pay attention to. Users should see WARNING and think, really ought to pay attention to. Users should see WARNING and think,
"Hmm, should I tell the Supybot developers about this?" Later, he should "Hmm, should I tell the Supybot developers about this?" Later, they should
decide not to, but it should give the user a moment to pause and think decide not to, but it should give the user a moment to pause and think
about what's actually happening with his bot. about what's actually happening with their bot.
* ERROR: Appropriate to tell a user when something has gone wrong. * ERROR: Appropriate to tell a user when something has gone wrong.
Uncaught exceptions are ERRORs. Conditions that we absolutely want to Uncaught exceptions are ERRORs. Conditions that we absolutely want to

10
use/capabilities.rst
View File

@ -72,7 +72,7 @@ itself, '-bar'. If so, it errors right then and there, telling the user that
he lacks the 'bar' capability. If the user doesn't have that anticapability, he lacks the 'bar' capability. If the user doesn't have that anticapability,
then the bot checks to see if the user issued the command over a channel, and then the bot checks to see if the user issued the command over a channel, and
if so, checks to see if the user has the antichannelcapability for that if so, checks to see if the user has the antichannelcapability for that
command, '#baz,-bar'. If so, again, he tells the user that he lacks the 'bar' command, '#baz,-bar'. If so, again, it tells the user that they lack the 'bar'
capability. If neither of these anticapabilities are present, then the bot capability. If neither of these anticapabilities are present, then the bot
just responds to the user like normal. just responds to the user like normal.
@ -96,8 +96,8 @@ reserved for people with the next capability.
People who are to administer channels with the bot should have the People who are to administer channels with the bot should have the
'#channel,op' capability--whatever channel they are to administrate, they '#channel,op' capability--whatever channel they are to administrate, they
should have that channel capability for 'op'. For example, since I want should have that channel capability for 'op'. For example, since I want
inkedmn to be an administrator in #supybot, I'll give him the '#supybot,op' inkedmn to be an administrator in #supybot, I'll give them the '#supybot,op'
capability. This is in addition to his 'admin' capability, since the 'admin' capability. This is in addition to their 'admin' capability, since the 'admin'
capability doesn't give the person having it control over channels. capability doesn't give the person having it control over channels.
'#channel,op' is used for such things as giving/receiving ops, kickbanning '#channel,op' is used for such things as giving/receiving ops, kickbanning
people, lobotomizing the bot, ignoring users in the channel, and managing the people, lobotomizing the bot, ignoring users in the channel, and managing the
@ -133,6 +133,6 @@ From an user's perspective, capabilities remove a lot of the mystery and
esotery of bot control, in addition to giving a bot owner absolutely esotery of bot control, in addition to giving a bot owner absolutely
finegrained control over what users are allowed to do with the bot. finegrained control over what users are allowed to do with the bot.
Additionally, defaults can be set by the bot owner for both individual channels Additionally, defaults can be set by the bot owner for both individual channels
and for the bot as a whole, letting an end-user set the policy he wants the bot and for the bot as a whole, letting an end-user set the policy they want the bot
to follow for users that haven't yet registered in his user database. It's to follow for users that haven't yet registered in their user database. It's
really a revolution! really a revolution!

2
use/configuration.rst
View File

@ -177,7 +177,7 @@ configuration and user/channel/ignore database configuration.
Just edit the interesting files and then give the bot the ``config Just edit the interesting files and then give the bot the ``config
reload`` command and it'll work as expected. Do note, however, that reload`` command and it'll work as expected. Do note, however, that
Supybot flushes his configuration files and database to disk every hour Supybot flushes its configuration files and database to disk every hour
or so, and if this happens after you've edited your configuration files or so, and if this happens after you've edited your configuration files
but before you reload your changes, you could lose the changes you made. but before you reload your changes, you could lose the changes you made.
To prevent this, set the `supybot.flush` value to 'Off' while editing To prevent this, set the `supybot.flush` value to 'Off' while editing

2
use/getting_started.rst
View File

@ -39,7 +39,7 @@ bot that you just made to join your channel? Try this in the channel::
supybot: list supybot: list
Replacing 'supybot' with the actual name you picked for your bot, of course. Replacing 'supybot' with the actual name you picked for your bot, of course.
Your bot should reply with a list of the plugins he currently has loaded. At Your bot should reply with a list of the plugins it currently has loaded. At
least `Admin`, `Channel`, `Config`, `Misc`, `Owner`, and `User` should be least `Admin`, `Channel`, `Config`, `Misc`, `Owner`, and `User` should be
there; if you used supybot-wizard to create your configuration file you may there; if you used supybot-wizard to create your configuration file you may
have many more plugins loaded. The list command can also be used to list the have many more plugins loaded. The list command can also be used to list the