Commit Graph

31 Commits

Author SHA1 Message Date
Valentin Lorentz
66ba7cb020 Plugin: Only show the first paragraph; as the whole help can be very long. 2021-04-05 17:42:40 +02:00
Valentin Lorentz
833af36b08 all plugins: auto-generate READMEs
Starting with this commit, there should be no "original" text
in READMEs.
Instead, the entire text should be in docstrings, and READMEs
should be automatically generated from these docstrings.

Motivation:

* The same help is available both via IRC and in the README
  (although the README can be more detailed, as only the first
  paragraph will be shown on IRC)
* This will allow auto-generating plugin help on docs.limnoria.net
  using the same content as the README, as it's sourced from the
  docstrings

Additionally, this converts all READMEs from Markdown to ReST,
because the documentation already uses ReST, and other docstrings
in the codebase are in ReST for this reason.
2021-04-05 17:42:31 +02:00
James Lu
1858eaf59e Plugin: support showing __maintainer__ field in the 'author' command 2019-11-16 11:41:13 -08:00
James Lu
a4701b258c Plugin: accept author name in 'contributors' command 2019-11-16 11:41:13 -08:00
James Lu
d3a2964705 Plugin: add missing substitution, check for supybot.authors.unknown explicitly 2019-10-19 12:02:14 -07:00
James Lu
75a96ffa17 Plugin: show individual contributions in 'contributors [nick]' as a list
Remove special handling of one word contributions as commands, which was never clearly documented and is prone to false positives.
2019-10-19 11:17:35 -07:00
James Lu
672652d780 Plugin: refactor the first half of 'contributors [nick]' 2019-10-19 11:10:42 -07:00
James Lu
65e3e18fe2 Plugin: simplify the 'contributors' command
- Remove author sorting; it's not obvious that this is being done anyways.
- Format author and contributors as separate sentences; conjunctions are messy for code and very language-specific.
2019-10-19 10:47:33 -07:00
James Lu
18f9a342b3 Throw out mungeEmail for supybot.Author
This has limited value these days, because 1) the email info for authors is most often in a public VCS already 2) it makes using the actual contact info harder.
2019-10-19 10:20:35 -07:00
Valentin Lorentz
f7943a6697 Plugin: make @plugins take non-first words into account. Closes GH-68. 2015-12-28 20:09:48 +01:00
Valentin Lorentz
8e427838cd Plugin: internationalize a string. 2015-12-28 20:04:31 +01:00
Valentin Lorentz
be118c3338 Remove use of fix_dict fixer. 2015-08-08 23:08:49 +02:00
nyuszika7h
1a7e584a53 Plugin: Remove duplicate !list command
It also exists in Misc.
2014-03-16 14:12:53 +01:00
Valentin Lorentz
06fdaa792f Continue accelerating the 2to3 step (remove fix_map). 2014-01-21 10:57:38 +01:00
Valentin Lorentz
3c42a1f513 Plugin: fix forgotten merge info 2011-02-26 10:44:35 +01:00
Daniel Folkinshteyn
7505f839fc fix docstring for Plugin.plugin command so it actually says what the command will do.
also add a Plugin.plugins command, which always returns a list of all plugins containing a command.
add a test for it.
2011-02-25 19:14:35 +01:00
Valentin Lorentz
db977bf5d2 Fix Python2.5 issue (class decorators)
Issue S-fr#5
2010-10-26 09:32:12 +02:00
Valentin Lorentz
1cc1ec93a5 Internationalize Config, Network, Plugin, and User 2010-10-16 13:51:27 +02:00
Štěpán Němec
a66034f852 Fix some typos/wordings.
Signed-off-by: James Vega <jamessan@users.sourceforge.net>
2009-08-26 16:34:12 -04:00
James Vega
c3cacbce76 Munge Author's email in __str__ instead of relying on munging the results of Author.__str__ 2006-07-14 20:54:31 +00:00
James Vega
a3e4fc5b1d Change the modeline to use softtabstop instead of tabstop. 2006-02-11 15:52:51 +00:00
James Vega
915f84cd08 plugins/Plugin: Move an if outside of a for loop, since it won't change during the for loop. 2005-05-10 22:09:50 +00:00
James Vega
df73547745 Fix up Plugin.contributors and a couple contributors dicts. 2005-04-26 02:53:08 +00:00
James Vega
9971e991fe Fix the modelines. 2005-03-23 20:07:45 +00:00
James Vega
38784b9ae6 Plugin needed a little format() love. 2005-03-10 05:22:05 +00:00
Ali Afshar
d13458726d Added getPluginHelp() method to return docstring for individual plugins. 2005-03-03 19:34:26 +00:00
Jeremy Fincher
74e4299636 Forgot a dot. 2005-02-24 09:13:33 +00:00
Kevin Murphy
48c472d493 Check for the unknown author and special case accordingly 2005-02-23 18:17:01 +00:00
James Vega
db36e979db Wrap Plugin.list. 2005-02-22 23:51:01 +00:00
Jeremy Fincher
8756b79cc4 Moved the appropriate commands from Misc to Plugin, and fixed the test failures in the process. 2005-02-18 06:31:26 +00:00
Jeremy Fincher
adff889c44 Added a skeletal Plugin plugin. 2005-02-09 07:07:11 +00:00