From 069ea800db9c71dd684290cadc52b81fe3e1c859 Mon Sep 17 00:00:00 2001 From: Seaswimmer Date: Tue, 28 May 2024 22:02:42 -0400 Subject: [PATCH] feat(seautils): added a detailed docstring to the rfc command --- seautils/seautils.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/seautils/seautils.py b/seautils/seautils.py index 06e704e..3281583 100644 --- a/seautils/seautils.py +++ b/seautils/seautils.py @@ -201,7 +201,18 @@ class SeaUtils(commands.Cog): @commands.command() async def rfc(self, ctx: commands.Context, number: int) -> None: - """Retrieve the text of an RFC document.""" + """Retrieve the text of an RFC document. + + This command uses the [RFC Editor website](https://www.rfc-editor.org/) to fetch the text of an RFC document. + `number` refers to the number of the RFC document you wish to retrieve. + Modified excerpt from the RFC Editor website: + >>> The RFC Series (ISSN 2070-1721) contains technical and organizational documents about the Internet, + including the specifications and policy documents produced by five streams: + - [Internet Engineering Task Force](https://www.ietf.org/) + - [Internet Research Task Force](https://www.irtf.org/) + - [Internet Architecture Board](https://www.iab.org/) + - [Independent Submissions](https://www.rfc-editor.org/independent) + - [Editorial](https://www.rfc-editor.org/info/rfc9280)""" url = f"https://www.rfc-editor.org/rfc/rfc{number}.html" async with aiohttp.ClientSession() as session: async with session.get(url=url) as response: