From 6b40bca0a361381167aef95e165f9908310a3739 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Hells=C3=A9n?= Date: Sat, 10 Dec 2022 23:52:35 +0100 Subject: [PATCH] Update docstring --- discord_rss_bot/main.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/discord_rss_bot/main.py b/discord_rss_bot/main.py index a873a48..6a2a091 100644 --- a/discord_rss_bot/main.py +++ b/discord_rss_bot/main.py @@ -51,7 +51,9 @@ templates: Jinja2Templates = Jinja2Templates(directory="templates") def encode_url(url_to_quote: str) -> str: - """%-escape the URL so it can be used in a URL. If we didn't do this, the URL could contain a ? + """%-escape the URL so it can be used in a URL. If we didn't do this, we couldn't go to feeds with a ? in the URL. + + You can use this in templates with {{ url | encode_url }}. Args: url_to_quote: The url to encode.