diff options
| author | Cody Logan <cody@lokken.dev> | 2023-12-01 15:33:21 -0800 |
|---|---|---|
| committer | Cody Logan <cody@lokken.dev> | 2023-12-01 15:33:21 -0800 |
| commit | 318d9ad1a4679832b380c77ab1a0a86684f686f2 (patch) | |
| tree | ee1bd8ad347c18b3fc44da388360634c3afd231c /src/wikiget/__init__.py | |
| parent | 488e859f8c343b0ef25db379b6339bf82769514b (diff) | |
| download | wikiget-318d9ad1a4679832b380c77ab1a0a86684f686f2.tar.gz wikiget-318d9ad1a4679832b380c77ab1a0a86684f686f2.zip | |
Switch to Google-style docstrings for readability
The previous Sphinx-style docstrings could be hard to read at a
glance when formatted with pydoc.
Diffstat (limited to 'src/wikiget/__init__.py')
| -rw-r--r-- | src/wikiget/__init__.py | 10 |
1 files changed, 5 insertions, 5 deletions
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 <https://www.gnu.org/licenses/>. -"""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 <https://github.com/clpo13/wikiget>. |