Skip to content

Commit 20d451f

Browse files
committed
Clarify docstrings
1 parent e695f11 commit 20d451f

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

cloudbot/util/colors.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,11 @@ def parse(string):
155155
return formatted
156156

157157

158-
# Color stripping.
158+
# Formatting stripping.
159159

160160
def strip(string):
161161
"""
162-
Removes all $() syntax color codes from the input string and returns it.
162+
Removes all $() syntax formatting codes from the input string and returns it.
163163
:rtype str
164164
"""
165165

@@ -174,7 +174,7 @@ def strip(string):
174174

175175
def strip_irc(string):
176176
"""
177-
Removes all raw MIRC color codes from the input string and returns it.
177+
Removes all raw MIRC formatting codes from the input string and returns it.
178178
:rtype str
179179
"""
180180

@@ -183,11 +183,11 @@ def strip_irc(string):
183183

184184
def strip_all(string):
185185
"""
186-
Removes all $() syntax and MIRC color codes from the input string and returns it.
186+
Removes all $() syntax and MIRC formatting codes from the input string and returns it.
187187
:rtype str
188188
"""
189189

190-
# we run strip_irc twice to avoid people putting a $() color code inside a MIRC one
190+
# we run strip_irc twice to avoid people putting a $() formatting code inside a MIRC one
191191
return strip_irc(strip(strip_irc(string)))
192192

193193

0 commit comments

Comments
 (0)