fix documentations

This commit is contained in:
Pedro de Oliveira 2019-06-11 00:29:29 +01:00
parent d2456cd4a4
commit 086466ea1b
5 changed files with 9 additions and 9 deletions

View File

@ -65,7 +65,7 @@ class GitHub(callbacks.Plugin):
def last(self, irc, msg, args, atom_url):
"""<atom_url>
Returns the last commit message from the specified atom url.
Returns the last commit message from a GitHub commit <atom url>.
"""
irc.reply(self.__parse_rss(atom_url), prefixNick=False)
last = wrap(last, ['httpUrl'])

View File

@ -139,9 +139,9 @@ class Inquisicao(callbacks.Plugin):
return json.loads(response.content.decode('utf-8'))
def find(self, irc, msg, args, text, position):
"""<text to find> [position]
"""<text> [position]
Returns the matched proccess with "text" at "position".
Returns the matched proccess with <text>, at [position].
"""
data = self.__do_request('adcautelam',
{

View File

@ -130,7 +130,7 @@ class LastFM(callbacks.Plugin):
def setuser(self, irc, msg, args, channel, user):
"""[<channel>] <last.fm user>
Assigns the last.fm user to the current nick.
Assigns the <last.fm user> to the current nick, in [channel].
"""
self.db.set_user(channel, msg.nick.lower(), user)
irc.reply("{} User set as {} for {}".format(
@ -143,7 +143,7 @@ class LastFM(callbacks.Plugin):
def nowplaying(self, irc, msg, args, channel, user):
"""[<channel>] [<last.fm user>]
Show the currently playing song.
Show the currently playing song, by [last.fm user], in [channel].
"""
if self.connect() is False:
return

View File

@ -66,16 +66,16 @@ class Maria(callbacks.Plugin):
def latest(self, irc, msg, args, position):
"""[position]
Returns the last message, or last + position.
Returns the last message, at [position].
"""
data = self.__do_request('latest', {'position': position})
irc.reply(self.__format_message(data, position), prefixNick=False)
latest = wrap(latest, [optional('int', default=0)])
def find(self, irc, msg, args, text, position):
"""<text to find> [position]
"""<text> [position]
Returns the matched message with "text" at "position".
Returns the matched message with <text>, at [position].
"""
data = self.__do_request('find',
{

View File

@ -57,7 +57,7 @@ class Priberam(callbacks.Plugin):
def find(self, irc, msg, args, word, position):
"""<word> [position]
Returns the dictionary definition of a word.
Returns the dictionary definition of a <word>, at [position].
"""
response = requests.get(
"https://dicionario.priberam.org/{}".format(urllib.parse.quote(word)),