Skip to content

Commit d52a723

Browse files
committed
add some descriptions
1 parent 930635c commit d52a723

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

src/discord-cluster-manager/report.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,22 @@ async def _send_split_log(thread: discord.Thread, partial_message: str, header:
4848

4949
@dataclasses.dataclass
5050
class Text:
51+
"""
52+
Text represents markdown-formatted text to be added to the report.
53+
"""
5154
text: str
5255

5356

5457
@dataclasses.dataclass
5558
class Log:
59+
"""
60+
Log represents a potentially extensive log of some operation, such as
61+
stdout/stderr of the compiler or tester script.
62+
Logs will be automatically wrapped in code blocks, and prefixed with
63+
the given header. If `content` is too long to fit into a single discord
64+
message, it can be broken up automatically (and reasonably) into multiple
65+
smaller messages.
66+
"""
5667
header: str
5768
content: str
5869

0 commit comments

Comments
 (0)