Rosie-Val/SeaCogs
1
0
Fork 0
Code Pull requests Activity

feat(seautils): added a detailed docstring to the rfc command

Browse source
This commit is contained in:
Seaswimmer 2024-05-28 22:02:42 -04:00
parent 58245c621c
commit 069ea800db
Signed by untrusted user: cswimr
GPG key ID: 5D671B5D03D65A7F
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
seautils/seautils.py
View file

@ -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: