From 318d9ad1a4679832b380c77ab1a0a86684f686f2 Mon Sep 17 00:00:00 2001 From: Cody Logan Date: Fri, 1 Dec 2023 15:33:21 -0800 Subject: Switch to Google-style docstrings for readability The previous Sphinx-style docstrings could be hard to read at a glance when formatted with pydoc. --- src/wikiget/__init__.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'src/wikiget/__init__.py') diff --git a/src/wikiget/__init__.py b/src/wikiget/__init__.py index 698fe46..d8f87bf 100644 --- a/src/wikiget/__init__.py +++ b/src/wikiget/__init__.py @@ -15,12 +15,12 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see . -"""Wikiget is a tool for downloading files from MediaWiki sites. +"""A tool for downloading files from MediaWiki sites. -It's similar in conception to download tools like wget, but wikiget can use the name of -the file or the URL of its description page to get the actual file's URL and download -it. Additionally, it can download multiple files at once by reading the targets from a -given text file. +Wikiget is similar in conception to download tools like wget, but wikiget can use the +name of the file or the URL of its description page to get the actual file's URL and +download it. Additionally, it can download multiple files at once by reading the targets +from a given text file. Further documentation can be found in the accompanying README.md file or at . -- cgit v1.2.3