instruction stringclasses 100
values | code stringlengths 78 193k | response stringlengths 259 170k | file stringlengths 59 203 |
|---|---|---|---|
Add detailed documentation for each class | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -51,6 +51,14 @@ window_start: int,
split_at: int,
) -> int:
+ """
+ Adjust the split point to avoid splitting inside short HTML entities
+ such as ' '.
+
+ If the split falls inside '&...;' within a small window around the
+ boundary, move the split back to '&' so the entire ent... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/format.py |
Expand my code with proper documentation strings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -87,6 +87,7 @@
class NotifyZulip(NotifyBase):
+ """A wrapper for Zulip Notifications."""
# The default descriptive name associated with the Notification
service_name = "Zulip"
@@ -176,6 +177,7 @@ default_notification_stream = "general"
def __init__(self, botname, organization, t... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/zulip.py |
Add minimal docstrings for each function | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -149,6 +149,7 @@
def is_ipaddr(addr, ipv4=True, ipv6=True):
+ """Validates against IPV4 and IPV6 IP Addresses."""
if ipv4:
# Based on https://stackoverflow.com/questions/5284147/\
@@ -197,6 +198,7 @@
def is_hostname(hostname, ipv4=True, ipv6=True, underscore=True):
+ """Validate... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/parse.py |
Add docstrings to clarify complex logic | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -74,6 +74,7 @@
class URLBase:
+ """This is the base class for all URL Manipulation."""
# The default descriptive name associated with the URL
service_name = None
@@ -196,6 +197,9 @@ # Internal Values
def __init__(self, asset=None, **kwargs):
+ """Initialize some general l... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/url.py |
Write reusable docstrings | # coding: utf-8
# YYeTsBot - fansub.py
# 2019/8/15 18:30
__author__ = "Benny <benny.think@gmail.com>"
import contextlib
import hashlib
import json
import logging
import os
import pickle
import re
import sys
import fakeredis
import pymongo
import redis
import requests
from bs4 import BeautifulSoup
from bson.objectid ... | --- +++ @@ -120,6 +120,13 @@
class BaseFansub:
+ """
+ all the subclass should implement three kinds of methods:
+ 1. online search, contains preview for bot and complete result
+ 2. login and check (set pass if not applicable)
+ 3. search_result as this is critical for bot to draw markup
+
+ """
... | https://raw.githubusercontent.com/tgbot-collection/YYeTsBot/HEAD/yyetsbot/fansub.py |
Add docstrings including usage examples | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -37,6 +37,7 @@
class NotifyNextcloudTalk(NotifyBase):
+ """A wrapper for Nextcloud Talk Notifications."""
# The default descriptive name associated with the Notification
service_name = _("Nextcloud Talk")
@@ -124,6 +125,7 @@ }
def __init__(self, targets=None, headers=None, url_p... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/nextcloudtalk.py |
Annotate my code with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -140,6 +140,7 @@
class NotifyPushover(NotifyBase):
+ """A wrapper for Pushover Notifications."""
# The default descriptive name associated with the Notification
service_name = "Pushover"
@@ -266,6 +267,7 @@ supplemental_url_title=None,
**kwargs,
):
+ """Initial... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pushover.py |
Add docstrings to my Python code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -39,6 +39,7 @@
class PushSaferSound:
+ """Defines all of the supported PushSafe sounds."""
# Silent
SILENT = 0
@@ -283,6 +284,7 @@
# Vibrations
class PushSaferVibration:
+ """Defines the acceptable vibration settings for notification."""
# x1
LOW = 1
@@ -313,6 +315,7 @@
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pushsafer.py |
Generate docstrings for each module | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -98,6 +98,7 @@
class SlackMode:
+ """Tracks the mode of which we're using Slack."""
# We're dealing with a webhook
# Our token looks like: T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7
@@ -123,6 +124,7 @@
class NotifySlack(NotifyBase):
+ """A wrapper for Slack Notifications."""
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/slack.py |
Add concise docstrings to each method | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -82,6 +82,7 @@
class TelegramMarkdownVersion:
+ """Telegram Markdown Version."""
# Classic (Original Telegram Markdown)
ONE = "MARKDOWN"
@@ -108,6 +109,7 @@
class TelegramContentPlacement:
+ """The Telegram Content Placement."""
# Before Attachments
BEFORE = "before"
@@ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/telegram.py |
Generate docstrings for script automation | #
# BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain... | --- +++ @@ -42,6 +42,7 @@
class NotifySpugpush(NotifyBase):
+ """A wrapper for SpugPush Notifications."""
# The default descriptive name associated with the Notification
service_name = _("SpugPush")
@@ -74,6 +75,7 @@ )
def __init__(self, token, **kwargs):
+ """Initialize SpugPush Ob... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/spugpush.py |
Document this module using docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -35,6 +35,8 @@
class syslog:
+ """Extrapoloated information from the syslog library so that this plugin
+ would not be dependent on it."""
# Notification Categories
LOG_KERN = 0
@@ -64,6 +66,7 @@
class SyslogFacility:
+ """All of the supported facilities."""
KERN = "kern"
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/rsyslog.py |
Provide docstrings following PEP 257 | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -66,6 +66,7 @@
class NotifyTechulusPush(NotifyBase):
+ """A wrapper for Techulus Push Notifications."""
# The default descriptive name associated with the Notification
service_name = "Techulus Push"
@@ -103,6 +104,7 @@ )
def __init__(self, apikey, **kwargs):
+ """Initiali... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/techuluspush.py |
Expand my code with proper documentation strings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -57,6 +57,7 @@
class NtfyMode:
+ """Define ntfy Notification Modes."""
# App posts upstream to the developer API on ntfy's website
CLOUD = "cloud"
@@ -76,6 +77,7 @@
class NtfyAuth:
+ """Define ntfy Authentication Modes."""
# Basic auth (user and password provided)
BASIC ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/ntfy.py |
Fully document this Python code with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -42,6 +42,7 @@
class NotifyServerChan(NotifyBase):
+ """A wrapper for ServerChan Notifications."""
# The default descriptive name associated with the Notification
service_name = "ServerChan"
@@ -76,6 +77,7 @@ )
def __init__(self, token, **kwargs):
+ """Initialize ServerCh... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/serverchan.py |
Annotate my code with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -65,6 +65,7 @@
class RedditMessageKind:
+ """Define the kinds of messages supported."""
# Attempt to auto-detect the type prior to passing along the message to
# Reddit
@@ -85,6 +86,7 @@
class NotifyReddit(NotifyBase):
+ """A wrapper for Notify Reddit Notifications."""
# The ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/reddit.py |
Add professional docstrings to my codebase | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -46,6 +46,9 @@
class NotifySendPulse(NotifyBase):
+ """
+ A wrapper for Notify SendPulse Notifications
+ """
# The default descriptive name associated with the Notification
service_name = "SendPulse"
@@ -177,6 +180,9 @@ def __init__(self, client_id, client_secret, from_addr=None,... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/sendpulse.py |
Add docstrings to my Python code | #
# BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain... | --- +++ @@ -40,6 +40,7 @@
class NotifyQQ(NotifyBase):
+ """A wrapper for QQ Push Notifications."""
# The default descriptive name associated with the Notification
service_name = _("QQ Push")
@@ -72,6 +73,11 @@ )
def __init__(self, token, **kwargs):
+ """Initialize QQ Push Object.
+
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/qq.py |
Create docstrings for reusable components | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -79,6 +79,7 @@
class NotifyMQTT(NotifyBase):
+ """A wrapper for MQTT Notifications."""
# Set our global enabled flag
enabled = NOTIFY_MQTT_SUPPORT_ENABLED
@@ -223,6 +224,7 @@ retain=None,
**kwargs,
):
+ """Initialize MQTT Object."""
super().__init__(... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/mqtt.py |
Add concise docstrings to each method | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -47,6 +47,7 @@
class NotifySMPP(NotifyBase):
+ """A wrapper for SMPP Notifications."""
# Set our global enabled flag
enabled = NOTIFY_SMPP_ENABLED
@@ -132,6 +133,7 @@ )
def __init__(self, source=None, targets=None, **kwargs):
+ """Initialize SMPP Object."""
sup... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/smpp.py |
Document this script properly | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -72,6 +72,7 @@
class NotifySendGrid(NotifyBase):
+ """A wrapper for Notify SendGrid Notifications."""
# The default descriptive name associated with the Notification
service_name = "SendGrid"
@@ -178,6 +179,7 @@ template_data=None,
**kwargs,
):
+ """Initialize ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/sendgrid.py |
Create simple docstrings for beginners | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -43,6 +43,7 @@
class NotifyViber(NotifyBase):
+ """Send a Viber Bot message using the Viber REST Bot API."""
# The default descriptive name associated with the Notification
service_name = _("Viber")
@@ -140,9 +141,11 @@ self.targets = parse_list(targets)
def __len__(self) ->... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/viber.py |
Add professional docstrings to my codebase | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -45,6 +45,7 @@
class NotifyPushBullet(NotifyBase):
+ """A wrapper for PushBullet Notifications."""
# The default descriptive name associated with the Notification
service_name = "Pushbullet"
@@ -118,6 +119,7 @@ )
def __init__(self, accesstoken, targets=None, **kwargs):
+ ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/pushbullet.py |
Fully document this Python code with docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -46,12 +46,15 @@
class ApprisePGPException(ApprisePluginException):
+ """Thrown when there is an error with the Pretty Good Privacy
+ Controller."""
def __init__(self, message, error_code=602):
super().__init__(message, error_code=error_code)
class ApprisePGPController:
+ ""... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/pgp.py |
Add docstrings for better understanding | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -63,6 +63,7 @@
class NotifyResend(NotifyBase):
+ """A wrapper for Notify Resend Notifications."""
# The default descriptive name associated with the Notification
service_name = "Resend"
@@ -162,6 +163,7 @@ def __init__(
self, apikey, from_addr, targets=None, cc=None, bcc=None,... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/resend.py |
Create Google-style docstrings for my code | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -55,6 +55,7 @@
class NotifyOffice365(NotifyBase):
+ """A wrapper for Office 365 Notifications."""
# The default descriptive name associated with the Notification
service_name = "Office 365"
@@ -185,6 +186,7 @@ bcc=None,
**kwargs,
):
+ """Initialize Office 365 O... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/office365.py |
Add docstrings to improve readability | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -52,6 +52,7 @@
class NotifyWindows(NotifyBase):
+ """A wrapper for local Windows Notifications."""
# Set our global enabled flag
enabled = NOTIFY_WINDOWS_SUPPORT_ENABLED
@@ -111,6 +112,7 @@ )
def __init__(self, include_image=True, duration=None, **kwargs):
+ """Initialize... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/windows.py |
Add structured docstrings to improve clarity | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -31,6 +31,7 @@
def base64_urlencode(data: bytes) -> str:
+ """URL Safe Base64 Encoding."""
try:
return base64.urlsafe_b64encode(data).rstrip(b"=").decode("utf-8")
@@ -40,6 +41,7 @@
def base64_urldecode(data: str) -> bytes:
+ """URL Safe Base64 Encoding."""
try:
#... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/base64.py |
Add verbose docstrings with examples | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -47,6 +47,7 @@
class NotifyPlivo(NotifyBase):
+ """A wrapper for Plivo Notifications."""
# The default descriptive name associated with the Notification
service_name = "Plivo"
@@ -143,6 +144,7 @@ def __init__(
self, auth_id, token, source, targets=None, batch=None, **kwargs
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/plivo.py |
Add docstrings explaining edge cases | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -40,6 +40,7 @@
class NotifySeven(NotifyBase):
+ """A wrapper for seven Notifications."""
# The default descriptive name associated with the Notification
service_name = "seven"
@@ -128,6 +129,7 @@ label=None,
**kwargs,
):
+ """Initialize Seven Object."""
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/seven.py |
Write reusable docstrings | #
# BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain... | --- +++ @@ -42,6 +42,7 @@
class NotifySpike(NotifyBase):
+ """A wrapper for Spike.sh Notifications."""
# The default descriptive name associated with the Notification
service_name = _("Spike.sh")
@@ -74,6 +75,7 @@ )
def __init__(self, token, **kwargs):
+ """Initialize Spike.sh Objec... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/spike.py |
Add detailed documentation for each class | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -79,6 +79,7 @@
class NotifyWebexTeams(NotifyBase):
+ """A wrapper for Webex Teams Notifications."""
# The default descriptive name associated with the Notification
service_name = "Cisco Webex Teams"
@@ -131,6 +132,7 @@ )
def __init__(self, token, **kwargs):
+ """Initializ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/webexteams.py |
Please document this code using docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -67,6 +67,7 @@
class NotifySNS(NotifyBase):
+ """A wrapper for AWS SNS (Amazon Simple Notification)"""
# The default descriptive name associated with the Notification
service_name = "AWS Simple Notification Service (SNS)"
@@ -168,6 +169,7 @@ targets=None,
**kwargs,
):... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/sns.py |
Add docstrings to meet PEP guidelines | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -43,6 +43,7 @@
class VapidPushMode:
+ """Supported Vapid Push Services."""
CHROME = "chrome"
FIREFOX = "firefox"
@@ -83,6 +84,7 @@
class NotifyVapid(NotifyBase):
+ """A wrapper for WebPush/Vapid notifications."""
# Set our global enabled flag
enabled = subscription.CRYPT... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/vapid/__init__.py |
Turn comments into proper docstrings | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -29,6 +29,7 @@
class TemplateType:
+ """Defines the different template types we can perform parsing on."""
# RAW does nothing at all to the content being parsed
# data is taken at it's absolute value
@@ -40,6 +41,20 @@
def apply_template(template, app_mode=TemplateType.RAW, **kwargs):
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/utils/templates.py |
Add documentation for all methods | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -80,6 +80,7 @@
class NotifyProwl(NotifyBase):
+ """A wrapper for Prowl Notifications."""
# The default descriptive name associated with the Notification
service_name = "Prowl"
@@ -146,6 +147,7 @@ )
def __init__(self, apikey, providerkey=None, priority=None, **kwargs):
+ "... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/prowl.py |
Create docstrings for each class method | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -71,11 +71,15 @@
class APIVersion:
+ """
+ Define API Versions
+ """
WORKFLOW = "2016-06-01"
POWER_AUTOMATE = "2022-03-01-preview"
class NotifyWorkflows(NotifyBase):
+ """A wrapper for Microsoft Workflows (MS Teams) Notifications."""
# The default descriptive name associ... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/workflows.py |
Help me add docstrings to my project | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -45,6 +45,7 @@
class SplunkAction:
+ """Tracks the actions supported by Apprise Splunk Plugin."""
# Use mapping (specify :key=arg to over-ride)
MAP = "map"
@@ -81,6 +82,7 @@
class SplunkMessageType:
+ """Defines the supported splunk message types."""
# Triggers an incident
... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/splunk.py |
Write clean docstrings for readability | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -49,6 +49,7 @@
class RocketChatAuthMode:
+ """The Chat Authentication mode is detected."""
# providing a webhook
WEBHOOK = "webhook"
@@ -69,6 +70,7 @@
class NotifyRocketChat(NotifyBase):
+ """A wrapper for Notify Rocket.Chat Notifications."""
# The default descriptive name as... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/rocketchat.py |
Generate docstrings for this script | # BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain t... | --- +++ @@ -47,6 +47,7 @@
class TwitterMessageMode:
+ """Twitter Message Mode."""
# DM (a Direct Message)
DM = "dm"
@@ -63,6 +64,7 @@
class NotifyTwitter(NotifyBase):
+ """A wrapper to Twitter Notifications."""
# The default descriptive name associated with the Notification
service... | https://raw.githubusercontent.com/caronc/apprise/HEAD/apprise/plugins/twitter.py |
Generate docstrings for this script |
from __future__ import annotations
import asyncio
import datetime
import logging
from typing import (
TYPE_CHECKING,
Any,
AsyncIterator,
Callable,
Coroutine,
Dict,
Generator,
List,
Literal,
Optional,
Sequence,
Tuple,
Type,
TypeVar,
TypedDict,
Union,
... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/client.py |
Document classes and their methods |
from __future__ import annotations
import copy
import time
import secrets
import asyncio
from datetime import datetime
from typing import (
Any,
AsyncIterator,
Callable,
Dict,
Generator,
Iterable,
List,
Literal,
Optional,
TYPE_CHECKING,
Protocol,
Sequence,
Tuple,
... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/abc.py |
Help me add docstrings to my project |
from __future__ import annotations
from typing import Any, Collection, Iterator, List, Optional, TYPE_CHECKING, Tuple
from .asset import Asset, AssetMixin
from .utils import SnowflakeList, snowflake_time, MISSING
from .partial_emoji import _EmojiTag, PartialEmoji
from .user import User
from .errors import MissingAppl... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/emoji.py |
Add clean documentation to messy code |
from __future__ import annotations
from typing import Dict, List, Optional, TYPE_CHECKING, Any, Tuple, Union
if TYPE_CHECKING:
from aiohttp import ClientResponse, ClientWebSocketResponse
from requests import Response
_ResponseType = Union[ClientResponse, Response]
from .interactions import Interacti... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/errors.py |
Document this script properly |
from __future__ import annotations
from typing import Any, Callable, Deque, Dict, Optional, Union, Generic, TypeVar, TYPE_CHECKING
from discord.enums import Enum
from discord.abc import PrivateChannel
import time
import asyncio
from collections import deque
from .errors import MaxConcurrencyReached
from .context im... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/cooldowns.py |
Auto-generate documentation strings for this file |
from __future__ import annotations
from typing import List, TYPE_CHECKING, Literal, Optional
from . import utils
from .asset import Asset
from .flags import ApplicationFlags
from .permissions import Permissions
from .utils import MISSING
if TYPE_CHECKING:
from typing import Dict, Any
from .guild import Gui... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/appinfo.py |
Include argument descriptions in docstrings |
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Dict, Iterable, Iterator, List, NamedTuple, Tuple
from ..member import Member
from ..object import Object
from ..role import Role
from ..message import Message, Attachment
from ..channel import PartialMessageable
from ..enums import AppCommandO... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/app_commands/namespace.py |
Fully document this Python code with docstrings |
from __future__ import annotations
import logging
import inspect
from typing import (
Any,
TYPE_CHECKING,
Callable,
Coroutine,
Dict,
Generator,
Generic,
List,
Literal,
Optional,
Sequence,
Set,
Tuple,
Union,
overload,
)
from collections import Counter
from ... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/app_commands/tree.py |
Include argument descriptions in docstrings |
from __future__ import annotations
from datetime import datetime
from .errors import MissingApplicationID
from ..flags import AppCommandContext, AppInstallationType, ChannelFlags
from .translator import TranslationContextLocation, TranslationContext, locale_str, Translator
from ..permissions import Permissions
from .... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/app_commands/models.py |
Add docstrings to incomplete code |
from __future__ import annotations
from typing import Any, TYPE_CHECKING, List, Optional, Sequence, Union
from ..enums import AppCommandOptionType, AppCommandType, Locale
from ..errors import DiscordException, HTTPException, _flatten_error_dict, MissingApplicationID as MissingApplicationID
from ..utils import _human... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/app_commands/errors.py |
Add docstrings to improve collaboration |
from __future__ import annotations
import datetime
import inspect
import re
from typing import (
TYPE_CHECKING,
Any,
Dict,
Generic,
Iterable,
List,
Literal,
Optional,
overload,
Protocol,
Tuple,
Type,
TypeVar,
Union,
runtime_checkable,
)
import types
import ... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/converter.py |
Help me comply with documentation standards |
from __future__ import annotations
import datetime
import inspect
import itertools
from operator import attrgetter
from typing import Any, Awaitable, Callable, Collection, Dict, List, Optional, TYPE_CHECKING, Tuple, TypeVar, Union
import discord.abc
from . import utils
from .asset import Asset
from .utils import MI... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/member.py |
Add docstrings to clarify complex logic |
from __future__ import annotations
import datetime
from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union, overload
from .asset import Asset
from .enums import ActivityType, StatusDisplayType, try_enum
from .colour import Colour
from .partial_emoji import PartialEmoji
from .utils import _get_as_snowflake... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/activity.py |
Please document this code using docstrings |
from __future__ import annotations
import inspect
import discord
import logging
from discord import app_commands
from discord.utils import maybe_coroutine, _to_kebab_case
from typing import (
Any,
Callable,
ClassVar,
Coroutine,
Dict,
Generator,
Iterable,
List,
Optional,
TYPE_C... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/cog.py |
Document this code for team use |
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Callable, ClassVar, Mapping, Generator, List, Optional, Tuple, Type, TypeVar, Union
from . import enums, flags, utils
from .asset import Asset
from .colour import Colour
from .invite import Invite
from .mixins import Hashable
from .object impo... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/audit_logs.py |
Document all public functions with docstrings |
from __future__ import annotations
import datetime
import inspect
from dataclasses import dataclass
from enum import Enum
from typing import (
TYPE_CHECKING,
Any,
Callable,
ClassVar,
Coroutine,
Dict,
Generic,
List,
Literal,
Optional,
Set,
Tuple,
Type,
TypeVar,
... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/app_commands/transformers.py |
Turn comments into proper docstrings |
from __future__ import annotations
from typing import Optional, TYPE_CHECKING
from .asset import Asset
from .enums import NameplatePalette, CollectibleType, try_enum
from .utils import parse_time
if TYPE_CHECKING:
from datetime import datetime
from .state import ConnectionState
from .types.user impor... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/collectible.py |
Add docstrings to improve collaboration |
from __future__ import annotations
import inspect
from typing import (
Any,
Callable,
ClassVar,
Coroutine,
Dict,
Generator,
Generic,
List,
MutableMapping,
Optional,
Set,
TYPE_CHECKING,
Tuple,
Type,
TypeVar,
Union,
overload,
)
import re
from copy imp... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/app_commands/commands.py |
Provide docstrings following PEP 257 |
from __future__ import annotations
from typing import List, Optional, Union, TYPE_CHECKING
from .asset import Asset
from .utils import parse_time, snowflake_time, _get_as_snowflake
from .object import Object
from .mixins import Hashable
from .enums import ChannelType, NSFWLevel, VerificationLevel, InviteTarget, Invit... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/invite.py |
Generate consistent docstrings |
from __future__ import annotations
from typing import Any, Dict, List, Optional, Union, overload, TYPE_CHECKING
from .asset import Asset
from .permissions import Permissions
from .colour import Colour
from .mixins import Hashable
from .utils import snowflake_time, _bytes_to_base64_data, _get_as_snowflake, MISSING
fro... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/role.py |
Fully document this Python code with docstrings |
from __future__ import annotations
from typing import AsyncIterator, Optional, TYPE_CHECKING
from datetime import datetime
from . import utils
from .enums import try_enum, SKUType, EntitlementType
from .flags import SKUFlags
from .object import Object
from .subscription import Subscription
if TYPE_CHECKING:
fr... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/sku.py |
Write beginner-friendly docstrings |
from __future__ import annotations
from typing import TYPE_CHECKING, Optional, Tuple
from .activity import create_activity
from .enums import Status, try_enum
from .utils import MISSING, _get_as_snowflake, _RawReprMixin
if TYPE_CHECKING:
from typing_extensions import Self
from .activity import ActivityType... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/presences.py |
Generate docstrings for script automation |
from __future__ import annotations
from typing import Union, Sequence, TYPE_CHECKING, Any
# fmt: off
__all__ = (
'AllowedMentions',
)
# fmt: on
if TYPE_CHECKING:
from typing_extensions import Self
from .types.message import AllowedMentions as AllowedMentionsPayload
from .abc import Snowflake
class... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/mentions.py |
Add inline docstrings for readability |
from __future__ import annotations
from typing import Optional, TYPE_CHECKING
from .utils import MISSING, cached_slot_property, _get_as_snowflake
from .mixins import Hashable
from .enums import PrivacyLevel, try_enum
# fmt: off
__all__ = (
'StageInstance',
)
# fmt: on
if TYPE_CHECKING:
from .types.channel ... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/stage_instance.py |
Please document this code using docstrings |
from __future__ import annotations
import asyncio
from collections import deque
import concurrent.futures
import logging
import struct
import sys
import time
import threading
import traceback
from typing import Any, Callable, Coroutine, Deque, Dict, List, TYPE_CHECKING, NamedTuple, Optional, TypeVar, Tuple
import a... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/gateway.py |
Create docstrings for all classes and functions |
from __future__ import annotations
from typing import Optional, List, TYPE_CHECKING, Union, AsyncIterator, Dict
import datetime
from .enums import PollLayoutType, try_enum, MessageType
from . import utils
from .emoji import PartialEmoji, Emoji
from .user import User
from .object import Object
from .errors import C... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/poll.py |
Help me write clear docstrings |
from __future__ import annotations
import datetime
from typing import Any, Dict, List, Optional, TYPE_CHECKING, Type, Tuple
from .utils import _get_as_snowflake, parse_time, MISSING
from .user import User
from .enums import try_enum, ExpireBehaviour
__all__ = (
'IntegrationAccount',
'IntegrationApplication',... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/integrations.py |
Include argument descriptions in docstrings |
from __future__ import annotations
import time
import random
from typing import Callable, Generic, Literal, TypeVar, overload, Union
T = TypeVar('T', bool, Literal[True], Literal[False])
# fmt: off
__all__ = (
'ExponentialBackoff',
)
# fmt: on
class ExponentialBackoff(Generic[T]):
def __init__(self, bas... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/backoff.py |
Add missing documentation to my Python functions |
from __future__ import annotations
import datetime
from typing import TYPE_CHECKING, Any, Dict, Optional, List, Set, Union, Sequence, overload, Literal
from .enums import AutoModRuleTriggerType, AutoModRuleActionType, AutoModRuleEventType, try_enum
from .flags import AutoModPresets
from . import utils
from .utils im... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/automod.py |
Generate docstrings for exported functions |
from __future__ import annotations
from typing import TYPE_CHECKING, Iterable, Optional, Set, List, Union
from .mixins import Hashable
from .enums import OnboardingMode, OnboardingPromptType, try_enum
from .partial_emoji import PartialEmoji
from .utils import cached_slot_property, MISSING
from . import utils
__all__... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/onboarding.py |
Generate docstrings for exported functions |
from __future__ import annotations
from typing import Optional, TYPE_CHECKING
from datetime import datetime
from .asset import Asset
from .utils import snowflake_time, _get_as_snowflake
if TYPE_CHECKING:
from .state import ConnectionState
from .types.user import PrimaryGuild as PrimaryGuildPayload
from ... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/primary_guild.py |
Add clean documentation to messy code |
from __future__ import annotations
import inspect
from operator import attrgetter
from typing import TYPE_CHECKING, Any, Literal, Optional, OrderedDict, Union, Protocol
from discord.utils import MISSING, maybe_coroutine
from .errors import NoPrivateMessage
from .converter import GuildConverter
from discord import ... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/parameters.py |
Add documentation for all methods |
from __future__ import annotations
import itertools
import copy
import functools
import re
from typing import (
TYPE_CHECKING,
Optional,
Generator,
List,
TypeVar,
Callable,
Any,
Dict,
Tuple,
Iterable,
Sequence,
Mapping,
TypedDict,
)
import discord.utils
from .cor... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/help.py |
Add docstrings that explain inputs and outputs |
from __future__ import annotations
import inspect
import re
import sys
from dataclasses import dataclass, field
from typing import TYPE_CHECKING, Any, Dict, Iterator, List, Literal, Optional, Pattern, Set, Tuple, Type, Union
from discord.utils import MISSING, maybe_coroutine, resolve_annotation
from .converter impo... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/flags.py |
Write proper docstrings for these functions |
from __future__ import annotations
from typing import List, Tuple, TypedDict, Any, TYPE_CHECKING, Callable, TypeVar, Literal, Optional, overload
import array
import ctypes
import ctypes.util
import logging
import math
import os.path
import struct
import sys
from .errors import DiscordException
if TYPE_CHECKING:
... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/opus.py |
Document this script properly |
from __future__ import annotations
from typing import Any, Optional, TYPE_CHECKING, List
from .utils import parse_time, _bytes_to_base64_data, MISSING, deprecated
from .guild import Guild
# fmt: off
__all__ = (
'Template',
)
# fmt: on
if TYPE_CHECKING:
import datetime
from .types.template import Templat... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/template.py |
Write reusable docstrings |
from __future__ import annotations
from .mixins import Hashable
from .utils import snowflake_time, MISSING
from typing import (
SupportsInt,
TYPE_CHECKING,
Type,
Union,
)
if TYPE_CHECKING:
import datetime
from . import abc
SupportsIntCast = Union[SupportsInt, str, bytes, bytearray]
# f... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/object.py |
Create docstrings for API functions |
from __future__ import annotations
from typing import Callable, Dict, Iterable, List, Literal, Optional, Sequence, Union, TYPE_CHECKING
from datetime import datetime
import array
from .mixins import Hashable
from .abc import Messageable, GuildChannel, _purge_helper
from .enums import ChannelType, try_enum
from .erro... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/threads.py |
Fill in missing docstrings in my code |
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Callable, List, Optional, Tuple, Union, Generic
from discord.errors import ClientException, DiscordException
from discord.utils import _human_join
from ._types import BotT
if TYPE_CHECKING:
from discord.abc import GuildChannel
from d... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/errors.py |
Add docstrings to improve code quality |
from __future__ import annotations
from typing import Literal, TYPE_CHECKING, List, Optional, Tuple, Type, Union
import unicodedata
from .mixins import Hashable
from .asset import Asset, AssetMixin
from .utils import cached_slot_property, snowflake_time, get, MISSING, _get_as_snowflake
from .enums import StickerType,... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/sticker.py |
Help me comply with documentation standards |
from __future__ import annotations
import asyncio
import datetime
import re
import io
from os import PathLike
from typing import (
Dict,
TYPE_CHECKING,
Literal,
Sequence,
Union,
List,
Optional,
Any,
Callable,
Tuple,
ClassVar,
Type,
overload,
)
from . import utils
f... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/message.py |
Fully document this Python code with docstrings |
from __future__ import annotations
import asyncio
import datetime
import functools
import inspect
from typing import (
TYPE_CHECKING,
Any,
Callable,
Dict,
Generator,
Generic,
List,
Literal,
Optional,
Set,
Tuple,
Type,
TypeVar,
Union,
overload,
TypedDict,... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/core.py |
Add standardized docstrings across the file |
from __future__ import annotations
from typing import TYPE_CHECKING, Optional
from . import utils
from .mixins import Hashable
from .partial_emoji import PartialEmoji, _EmojiTag
from .user import User
from .utils import MISSING
from .asset import Asset, AssetMixin
if TYPE_CHECKING:
import datetime
from typi... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/soundboard.py |
Include argument descriptions in docstrings |
from __future__ import annotations
import asyncio
import datetime
import logging
from typing import (
Any,
Callable,
Coroutine,
Generic,
List,
Optional,
Type,
TypeVar,
Union,
overload,
)
import aiohttp
import discord
import inspect
from collections.abc import Sequence
from di... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/tasks/__init__.py |
Write beginner-friendly docstrings |
from __future__ import annotations
from typing import TYPE_CHECKING, ClassVar, List, Optional, Sequence
__all__ = (
'AppInstallationType',
'AppCommandContext',
)
if TYPE_CHECKING:
from typing_extensions import Self
from ..types.interactions import InteractionContextType, InteractionInstallationType
... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/app_commands/installs.py |
Generate docstrings for each module |
from __future__ import annotations
import colorsys
import random
import re
from typing import TYPE_CHECKING, Optional, Tuple, Union
if TYPE_CHECKING:
from typing_extensions import Self
__all__ = (
'Colour',
'Color',
)
RGB_REGEX = re.compile(r'rgb\s*\((?P<r>[0-9.]+%?)\s*,\s*(?P<g>[0-9.]+%?)\s*,\s*(?P<b... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/colour.py |
Write docstrings for this repository |
from __future__ import annotations
from typing import (
Any,
Coroutine,
Dict,
Hashable,
Union,
Callable,
TypeVar,
Optional,
TYPE_CHECKING,
)
import time
from .commands import check
from .errors import (
NoPrivateMessage,
MissingRole,
MissingAnyRole,
MissingPermiss... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/app_commands/checks.py |
Include argument descriptions in docstrings |
from __future__ import annotations
import types
from collections import namedtuple
from typing import Any, ClassVar, Dict, List, Optional, TYPE_CHECKING, Tuple, Type, TypeVar, Iterator, Mapping
__all__ = (
'Enum',
'ChannelType',
'MessageType',
'SpeakingState',
'VerificationLevel',
'ContentFil... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/enums.py |
Help me write clear docstrings |
from __future__ import annotations
import threading
import subprocess
import warnings
import audioop
import asyncio
import logging
import shlex
import time
import json
import sys
import re
import io
from typing import Any, Callable, Generic, IO, Optional, TYPE_CHECKING, Tuple, TypeVar, Union
from .enums import Spea... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/player.py |
Write docstrings for utility functions |
from __future__ import annotations
import re
from typing import TYPE_CHECKING, Any, Dict, Generator, Generic, List, Optional, TypeVar, Union, Sequence, Type, overload
import discord.abc
import discord.utils
from discord import Interaction, Message, Attachment, MessageType, User, PartialMessageable, Permissions, Chan... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/context.py |
Document this code for team use |
from __future__ import annotations
from typing import (
ClassVar,
List,
Literal,
Optional,
TYPE_CHECKING,
Tuple,
Union,
)
from .asset import AssetMixin
from .enums import (
try_enum,
ComponentType,
ButtonStyle,
TextStyle,
ChannelType,
SelectDefaultValueType,
Se... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/components.py |
Fill in missing docstrings in my code |
from __future__ import annotations
import datetime
from typing import List, Optional, TYPE_CHECKING
from . import utils
from .mixins import Hashable
from .enums import try_enum, SubscriptionStatus
if TYPE_CHECKING:
from .state import ConnectionState
from .types.subscription import Subscription as Subscripti... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/subscription.py |
Generate docstrings for exported functions |
from __future__ import annotations
import datetime
from typing import TYPE_CHECKING, Literal, Optional, Set, List, Union
from .enums import ChannelType, try_enum, ReactionType
from .utils import _get_as_snowflake, _RawReprMixin
from .app_commands import AppCommandPermissions
from .colour import Colour
if TYPE_CHECK... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/raw_models.py |
Add well-formatted docstrings |
from __future__ import annotations
import asyncio
import logging
import sys
from typing import (
Any,
ClassVar,
Coroutine,
Dict,
Iterable,
List,
Literal,
NamedTuple,
Optional,
overload,
Sequence,
Tuple,
TYPE_CHECKING,
Type,
TypeVar,
Union,
)
from urllib.... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/http.py |
Generate missing documentation strings |
from __future__ import annotations
import datetime
from typing import Any, Dict, List, Mapping, Optional, Protocol, TYPE_CHECKING, TypeVar, Union
from . import utils
from .colour import Colour
from .flags import AttachmentFlags, EmbedFlags
# fmt: off
__all__ = (
'Embed',
)
# fmt: on
class EmbedProxy:
def ... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/embeds.py |
Generate docstrings for script automation |
from __future__ import annotations
from typing import (
Any,
AsyncIterator,
Callable,
Dict,
Iterable,
List,
Literal,
Mapping,
NamedTuple,
Optional,
TYPE_CHECKING,
Sequence,
Tuple,
TypeVar,
TypedDict,
Union,
overload,
)
import datetime
import discord... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/channel.py |
Provide clean and structured docstrings |
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Generic, Literal, Optional, TypeVar, Union, overload
from .errors import TranslationError
from ..enums import Enum, Locale
if TYPE_CHECKING:
from .commands import Command, ContextMenu, Group, Parameter
from .models import Choice
__al... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/app_commands/translator.py |
Add well-formatted docstrings |
from __future__ import annotations
from functools import reduce
from operator import or_
from typing import (
TYPE_CHECKING,
Any,
Callable,
ClassVar,
Dict,
Iterator,
List,
Optional,
Sequence,
Tuple,
Type,
TypeVar,
overload,
TypedDict,
)
from .enums import UserF... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/flags.py |
Generate docstrings for exported functions |
from __future__ import annotations
import struct
from typing import TYPE_CHECKING, ClassVar, IO, Generator, Tuple, Optional
from .errors import DiscordException
__all__ = (
'OggError',
'OggPage',
'OggStream',
)
class OggError(DiscordException):
pass
# https://tools.ietf.org/html/rfc3533
# http... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/oggparse.py |
Generate docstrings for this script |
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Callable, ClassVar, Dict, List, Tuple, Type, TypeVar, Union, Optional
import discord
import inspect
from discord import app_commands
from discord.utils import MISSING, maybe_coroutine, async_all
from .core import Command, Group
from .errors im... | --- +++ @@ -1,3 +1,26 @@+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the ... | https://raw.githubusercontent.com/Rapptz/discord.py/HEAD/discord/ext/commands/hybrid.py |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.