Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-02 17:29:22 +01:00
Code Issues Projects Releases Wiki Activity

Updated.

Browse Source
This commit is contained in:
Jeremy Fincher 2003-09-06 06:39:03 +00:00
parent 74d3b7820f
commit 1ad26525b9
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/STYLE
View File

@ -29,7 +29,9 @@ definitions in a file. Comments are even better than blank lines for
separating classes. separating classes.
Code should pass PyChecker with no warnings. The PyChecker config file is Code should pass PyChecker with no warnings. The PyChecker config file is
included in the tools/ subdirectory. included in the tools/ subdirectory. (Note: It's becoming harder and
harder to do this in today's Python. Just try to have as few warnings
as possible.)
Database filenames should generally begin with the name of the plugin and the Database filenames should generally begin with the name of the plugin and the
extension should be 'db'. baseplugin.DBHandler does this already. extension should be 'db'. baseplugin.DBHandler does this already.
@ -43,13 +45,12 @@ Instead, do this:
fd.close() fd.close()
This is to be sure the bot doesn't leak file descriptors. This is to be sure the bot doesn't leak file descriptors.
All plugins should include a docstring decsribing what the plugin does. After All plugins should include a docstring decsribing what the plugin
the decsription, the plugin should have a blank line followed by the line does. This docstring will be returned when the user wants help on a
'Commands include:' followed by a list of commands, one per line, indented two plugin.
spaces. The setup script will depend on this format.
Method docstrings in classes deriving from callbacks.Privmsg should include an Method docstrings in classes deriving from callbacks.Privmsg should include an
argument list as their first line, and (if necessary) a blank line followed by argument list as their first line, and after that a blank line followed by
a longer description of what the command does. The argument list is used by a longer description of what the command does. The argument list is used by
the 'help' command, and the longer description is used by the 'morehelp' the 'help' command, and the longer description is used by the 'morehelp'
command. command.
@ -72,3 +73,9 @@ words. This is because SQL itself is case-insensitive.
SQL statements in code should put SQL words in ALL CAPS: SQL statements in code should put SQL words in ALL CAPS:
SELECT quote FROM quotes ORDER BY random() LIMIT 1 SELECT quote FROM quotes ORDER BY random() LIMIT 1
All plugins should have test cases written for them. Even if it
doesn't actually test anything but just subclasses
test.PluginDocumentation, it's good to have the test there so there's
a place to add more tests later (and so we can be sure that all
plugins are adequately documented).