Remove module docstring
This commit is contained in:
@ -1,26 +1,3 @@
|
||||
"""
|
||||
Functions:
|
||||
add_feed()
|
||||
Add a feed to the reader. This also updates the feed.
|
||||
check_feed()
|
||||
Check a single feed.
|
||||
check_feeds()
|
||||
Check all feeds.
|
||||
send_to_discord()
|
||||
Send entries to Discord.
|
||||
update_feed()
|
||||
Update a feed.
|
||||
|
||||
Classes:
|
||||
IfFeedError
|
||||
Used in add_feed() and update_feed(). If an error, it will return IfFeedError with error=True.
|
||||
If no error, it will return IfFeedError with error=False.
|
||||
|
||||
Exceptions:
|
||||
NoWebhookFoundError
|
||||
Used in send_to_discord(). If no webhook found, it will raise NoWebhookFoundError.
|
||||
"""
|
||||
|
||||
from typing import Iterable
|
||||
|
||||
from discord_webhook import DiscordWebhook
|
||||
|
@ -1,6 +1,3 @@
|
||||
"""This is used as a healthcheck in the Dockerfile.
|
||||
The normal way would probably be to use CURL, but then we would have to install it."""
|
||||
|
||||
import sys
|
||||
|
||||
import requests
|
||||
|
@ -1,31 +1,3 @@
|
||||
"""
|
||||
The main file for the discord-rss-bot.
|
||||
|
||||
This file is used to start the bot.
|
||||
|
||||
Functions:
|
||||
check_feed() -> /check
|
||||
POST - Update a feed.
|
||||
crete_feed() -> /add
|
||||
POST - Create a new feed.
|
||||
favicon() -> /favicon.ico
|
||||
GET - Return the favicon.
|
||||
get_add() -> /add
|
||||
GET - Page for adding a new feed.
|
||||
get_feed() -> /feed
|
||||
GET - Page for a single feed.
|
||||
index() -> /
|
||||
GET - index page.
|
||||
remove_feed() -> /remove
|
||||
POST - Remove a feed.
|
||||
|
||||
create_list_of_webhooks()
|
||||
Create a list with webhooks.
|
||||
make_context_index()
|
||||
Create the needed context for the index page.
|
||||
startup()
|
||||
Runs on startup.
|
||||
"""
|
||||
import urllib.parse
|
||||
from datetime import datetime
|
||||
from typing import Any, Iterable
|
||||
|
@ -1,17 +1,3 @@
|
||||
"""This module contains functions for reading and writing settings and configuration files.
|
||||
|
||||
Functions:
|
||||
create_settings_file:
|
||||
Create the settings file if it doesn't exist.
|
||||
get_db_file:
|
||||
Where we store the database file.
|
||||
read_settings_file:
|
||||
Read the settings file and return it as a dict.
|
||||
|
||||
Variables:
|
||||
data_dir:
|
||||
Where we store the database and settings file.
|
||||
"""
|
||||
import logging
|
||||
import os
|
||||
|
||||
|
Reference in New Issue
Block a user