Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clock: add help prefix to output examples #1878

Merged
merged 2 commits into from
Jun 12, 2020
Merged

clock: add help prefix to output examples #1878

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e1e720
clock: add help prefix to output examples, fixes #1793
Exirel May 31, 2020
4089933
clock: improve and tweak help examples and docstrings
Exirel May 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 49 additions & 35 deletions sopel/modules/clock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# coding=utf-8
"""
clock.py - Sopel Clock Module
"""clock.py - Sopel Clock Plugin

Copyright 2008-9, Sean B. Palmer, inamidst.com
Copyright 2012, Elsie Powell, embolalia.com
Licensed under the Eiffel Forum License 2.
Expand All @@ -20,9 +20,10 @@


@module.commands('t', 'time')
@module.example('.t America/New_York')
@module.example('.t Exirel')
@module.example('.t #sopel')
@module.example('.t America/New_York', user_help=True)
@module.example('.t Exirel', user_help=True)
@module.example('.t #sopel', user_help=True)
@module.example('.t', user_help=True)
def f_time(bot, trigger):
"""Return the current time.

Expand All @@ -33,11 +34,7 @@ def f_time(bot, trigger):
it will complain. If nothing can be found, it'll complain that the argument
is not a valid timezone.

.. seealso::

Function :func:`~sopel.tools.time.format_time` is used to format
the current datetime according to the timezone (if found).

The format used can be set with the ``settf`` or ``setctf`` commands.
"""
argument = trigger.group(2)

Expand Down Expand Up @@ -98,7 +95,7 @@ def f_time(bot, trigger):
def f_time_zone(bot, trigger):
"""Return the current time in a timezone.

Unlike the ``.t`` command, it requires an argument, and that argument
Unlike the ``time`` command, it requires an argument, and that argument
must be a valid timezone.
"""
argument = trigger.group(2)
Expand Down Expand Up @@ -151,9 +148,13 @@ def update_user(bot, trigger):


@module.commands('gettz', 'gettimezone')
@module.example('.gettz [nick]')
@module.example('.gettz Exirel', user_help=True)
@module.example('.gettz', user_help=True)
def get_user_tz(bot, trigger):
"""Gets a user's preferred time zone; will show yours if no user specified."""
"""Gets a user's preferred time zone.

It will show yours if no user specified.
"""
nick = trigger.group(2)
if not nick:
nick = trigger.nick
Expand All @@ -170,9 +171,10 @@ def get_user_tz(bot, trigger):
@module.commands('settimeformat', 'settf')
@module.example('.settf %Y-%m-%dT%T%z')
def update_user_format(bot, trigger):
"""
Sets your preferred format for time. Uses the standard strftime format. You
can use <http://strftime.net> or your favorite search engine to learn more.
"""Sets your preferred format for time.

Uses the standard strftime format. You can use <http://strftime.net> or
your favorite search engine to learn more.
"""
tformat = trigger.group(2)
if not tformat:
Expand All @@ -196,15 +198,21 @@ def update_user_format(bot, trigger):
# New format doesn't work. Revert save in database.
bot.db.set_nick_value(trigger.nick, 'time_format', old_format)
return

set_command = '%ssettz' % bot.settings.core.help_prefix
bot.reply("Got it. Your time will now appear as %s. (If the "
"timezone is wrong, you might try the settz command)"
% timef)
"timezone is wrong, you might try the %s command)"
% (timef, set_command))


@module.commands('gettimeformat', 'gettf')
@module.example('.gettf [nick]')
@module.example('.gettf Exirel', user_help=True)
@module.example('.gettf', user_help=True)
def get_user_format(bot, trigger):
"""Gets a user's preferred time format; will show yours if no user specified."""
"""Gets a user's preferred time format.

It will show yours if no user specified.
"""
nick = trigger.group(2)
if not nick:
nick = trigger.nick
Expand All @@ -224,7 +232,7 @@ def get_user_format(bot, trigger):
@module.example('.setctz America/New_York')
@module.require_privilege(module.OP, message='Changing the channel timezone requires OP privileges.')
def update_channel(bot, trigger):
"""Set the preferred timezone for the channel."""
"""Set the preferred timezone for the current channel."""
argument = trigger.group(2)
if not argument:
bot.reply("What timezone do you want to set? Try one from "
Expand All @@ -250,11 +258,12 @@ def update_channel(bot, trigger):


@module.commands('getchanneltz', 'getctz')
@module.example('.getctz [channel]')
@module.example('.getctz #sopel', user_help=True)
@module.example('.getctz', user_help=True)
def get_channel_tz(bot, trigger):
"""
Gets the channel's preferred timezone; returns the current channel's
if no channel name is given.
"""Gets the channel's preferred timezone.

It returns the current channel's if no channel name is given.
"""
channel = trigger.group(2)
if not channel:
Expand All @@ -273,9 +282,10 @@ def get_channel_tz(bot, trigger):
@module.example('.setctf %Y-%m-%dT%T%z')
@module.require_privilege(module.OP)
def update_channel_format(bot, trigger):
"""
Sets your preferred format for time. Uses the standard strftime format. You
can use <http://strftime.net> or your favorite search engine to learn more.
"""Sets your preferred format for time.

Uses the standard strftime format. You can use <http://strftime.net> or
your favorite search engine to learn more.
"""
tformat = trigger.group(2)
if not tformat:
Expand All @@ -299,20 +309,24 @@ def update_channel_format(bot, trigger):
bot.db.set_channel_value(trigger.sender, 'time_format', old_format)
return
bot.db.set_channel_value(trigger.sender, 'time_format', tformat)

help_prefix = bot.settings.core.help_prefix
set_command = '%ssettz' % help_prefix
channel_command = '%schanneltz' % help_prefix
bot.reply("Got it. Times in this channel will now appear as %s "
"unless a user has their own format set. (If the timezone"
" is wrong, you might try the settz and channeltz "
"commands)" % timef)
" is wrong, you might try the %s and %s "
"commands)" % (timef, set_command, channel_command))


@module.commands('getchanneltimeformat', 'getctf')
@module.example('.getctf [channel]')
@module.example('.getctf #sopel', user_help=True)
@module.example('.getctf', user_help=True)
def get_channel_format(bot, trigger):
"""
Gets the channel's preferred time format; will return current channel's if
no channel name is given.
"""
"""Gets the channel's preferred time format

It returns the current channel's if no channel name is given.
"""
channel = trigger.group(2)
if not channel:
channel = trigger.sender
Expand Down