aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar kwzrd <[email protected]>2020-03-19 23:31:24 +0100
committerGravatar kwzrd <[email protected]>2020-03-19 23:44:06 +0100
commit93e6b53ee9853016d6c3b2d5a338480090c52667 (patch)
treeca50b8cbab73319afaf28889225acf5913d9d787
parentDeseasonify: add colour attr to seasonal classes (diff)
Deseasonify: turn legacy docstrings into attrs
We no longer use the class docstrings for announcements, and they mostly contain outdated information. Sentences still relevant are used to populate the `description` attr (which shows in the branding embed), the rest is scrapped. The descriptions themselves can still be improved in the future, once we figure out exactly in which direction we want to go with them. The idea of providing a description for each season's branding was originally brought up by neonsea, co-authored below. Co-authored-by: Rasmus Moorats <[email protected]>
-rw-r--r--bot/seasons/christmas/__init__.py14
-rw-r--r--bot/seasons/easter/__init__.py23
-rw-r--r--bot/seasons/halloween/__init__.py9
-rw-r--r--bot/seasons/pride/__init__.py25
-rw-r--r--bot/seasons/valentines/__init__.py7
-rw-r--r--bot/seasons/wildcard/__init__.py16
6 files changed, 24 insertions, 70 deletions
diff --git a/bot/seasons/christmas/__init__.py b/bot/seasons/christmas/__init__.py
index 33a8cfea..0b524f44 100644
--- a/bot/seasons/christmas/__init__.py
+++ b/bot/seasons/christmas/__init__.py
@@ -3,20 +3,16 @@ from bot.seasons import SeasonBase
class Christmas(SeasonBase):
- """
- Christmas seasonal event attributes.
-
- We are getting into the festive spirit with a new server icon, new bot name and avatar, and some
- new commands for you to check out!
-
- No matter who you are, where you are or what beliefs you may follow, we hope every one of you
- enjoy this festive season!
- """
+ """Branding for december."""
season_name = "Festive season"
bot_name = "Merrybot"
colour = Colours.soft_red
+ description = (
+ "The time is here to get into the festive spirit! No matter who you are, where you are, "
+ "or what beliefs you may follow, we hope every one of you enjoy this festive season!"
+ )
branding_path = "seasonal/christmas"
diff --git a/bot/seasons/easter/__init__.py b/bot/seasons/easter/__init__.py
index eeac45a1..15992941 100644
--- a/bot/seasons/easter/__init__.py
+++ b/bot/seasons/easter/__init__.py
@@ -3,29 +3,16 @@ from bot.seasons import SeasonBase
class Easter(SeasonBase):
- """
- Here at Python Discord, we celebrate our version of Easter during the entire month of April.
-
- While this celebration takes place, you'll notice a few changes:
-
- • The server icon has changed to our Easter icon. Thanks to <@140605665772175361> for the
- design!
-
- • [Easter issues now available for SeasonalBot on the repo](https://git.io/fjkvQ).
-
- • You may see stuff like an Easter themed esoteric challenge, a celebration of Earth Day, or
- Easter-related micro-events for you to join. Stay tuned!
-
- If you'd like to contribute, head on over to <#635950537262759947> and we will help you get
- started. It doesn't matter if you're new to open source or Python, if you'd like to help, we
- will find you a task and teach you what you need to know.
- """
+ """Branding for april."""
season_name = "Easter"
bot_name = "BunnyBot"
colour = Colours.bright_green
- description = "Bunny here, bunny there, bunny everywhere!"
+ description = (
+ "Bunny here, bunny there, bunny everywhere! Here at Python Discord, we celebrate "
+ "our version of Easter during the entire month of April."
+ )
branding_path = "seasonal/easter"
diff --git a/bot/seasons/halloween/__init__.py b/bot/seasons/halloween/__init__.py
index 23923eec..ec546578 100644
--- a/bot/seasons/halloween/__init__.py
+++ b/bot/seasons/halloween/__init__.py
@@ -3,18 +3,13 @@ from bot.seasons import SeasonBase
class Halloween(SeasonBase):
- """
- Halloween Seasonal event attributes.
-
- Announcement for this cog temporarily disabled, since we're doing a custom
- Hacktoberfest announcement. If you're enabling the announcement again,
- make sure to update this docstring accordingly.
- """
+ """Branding for october."""
season_name = "Halloween"
bot_name = "NeonBot"
colour = Colours.orange
+ description = "Trick or treat?!"
branding_path = "seasonal/halloween"
diff --git a/bot/seasons/pride/__init__.py b/bot/seasons/pride/__init__.py
index cc79a72b..90e2fde9 100644
--- a/bot/seasons/pride/__init__.py
+++ b/bot/seasons/pride/__init__.py
@@ -3,28 +3,19 @@ from bot.seasons import SeasonBase
class Pride(SeasonBase):
- """
- The month of June is a special month for us at Python Discord.
-
- It is very important to us that everyone feels welcome here, no matter their origin,
- identity or sexuality. During the month of June, while some of you are participating in Pride
- festivals across the world, we will be celebrating individuality and commemorating the history
- and challenges of the LGBTQ+ community with a Pride event of our own!
-
- While this celebration takes place, you'll notice a few changes:
- • The server icon has changed to our Pride icon. Thanks to <@98694745760481280> for the design!
- • [Pride issues are now available for SeasonalBot on the repo](https://git.io/pythonpride).
- • You may see Pride-themed esoteric challenges and other microevents.
-
- If you'd like to contribute, head on over to <#635950537262759947> and we will help you get
- started. It doesn't matter if you're new to open source or Python, if you'd like to help, we
- will find you a task and teach you what you need to know.
- """
+ """Branding for june."""
season_name = "Pride"
bot_name = "ProudBot"
colour = Colours.pink
+ description = (
+ "The month of June is a special month for us at Python Discord. It is very important to us "
+ "that everyone feels welcome here, no matter their origin, identity or sexuality. During the "
+ "month of June, while some of you are participating in Pride festivals across the world, "
+ "we will be celebrating individuality and commemorating the history and challenges "
+ "of the LGBTQ+ community with a Pride event of our own!"
+ )
branding_path = "seasonal/pride"
diff --git a/bot/seasons/valentines/__init__.py b/bot/seasons/valentines/__init__.py
index 67385c94..02cf11ff 100644
--- a/bot/seasons/valentines/__init__.py
+++ b/bot/seasons/valentines/__init__.py
@@ -3,16 +3,13 @@ from bot.seasons import SeasonBase
class Valentines(SeasonBase):
- """
- Love is in the air! We've got a new icon and set of commands for the season of love.
-
- Get yourself into the bot-commands channel and check out the new features!
- """
+ """Branding for february."""
season_name = "Valentines"
bot_name = "TenderBot"
colour = Colours.pink
+ description = "Love is in the air!"
branding_path = "seasonal/valentines"
diff --git a/bot/seasons/wildcard/__init__.py b/bot/seasons/wildcard/__init__.py
index c628d62e..bcc79e3a 100644
--- a/bot/seasons/wildcard/__init__.py
+++ b/bot/seasons/wildcard/__init__.py
@@ -3,24 +3,12 @@ from bot.seasons import SeasonBase
class Wildcard(SeasonBase):
- """
- For the month of August, the season is a Wildcard.
-
- This docstring will not be used for announcements.
- Instead, we'll do the announcement manually, since
- it will change every year.
-
- This class needs slight changes every year,
- such as the bot_name, bot_icon and icon.
-
- IMPORTANT: DO NOT ADD ANY FEATURES TO THIS FOLDER.
- ALL WILDCARD FEATURES SHOULD BE ADDED
- TO THE EVERGREEN FOLDER!
- """
+ """Branding for august."""
season_name = "Wildcard"
bot_name = "RetroBot"
colour = Colours.purple
+ description = "A season full of surprises!"
months = {Month.august}