Skip to content
This repository was archived by the owner on Oct 15, 2025. It is now read-only.

Commit ef92234

Browse files
ManuelSchneid3rManuelSchneid3r
committed
Let all descriptions have the required format.
1 parent ff319d5 commit ef92234

40 files changed

+207
-122
lines changed

‎api_test/__init__.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# -*- coding: utf-8 -*-
22

3-
"""This is a simple python template extension that should show the API in a comprehensible way. \
4-
Use the module docstring to provide a detailed description of the extension"""
3+
"""This is a simple python template extension.
4+
5+
This extension should show the API in a comprehensible way. Use the module docstring to provide a \
6+
description of the extension. The docstring should have three paragraphs: A brief description in \
7+
the first line, an optional elaborate description of the plugin, and finally the synopsis of the \
8+
extension.
9+
10+
Synopsis: <trigger> [delay|throw] <query>"""
511

612
from albertv0 import *
713
import os

‎arch_wiki/__init__.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# -*- coding: utf-8 -*-
22

3-
"""Search Arch Linux Wiki articles."""
3+
"""Search Arch Linux Wiki articles.
4+
5+
Synopsis: <trigger> <filter>"""
46

57
from albertv0 import *
68
from urllib import request, parse

‎atom_projects.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# -*- coding: utf-8 -*-
22

3-
"""List and open your Atom projects."""
3+
"""List and open your Atom projects.
4+
5+
Synopsis: <trigger> [filter]"""
46

57
import os
68
import re

‎aur/__init__.py‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# -*- coding: utf-8 -*-
22

3-
"""This extension adapts the AUR web interface. You can search for packages and open their URLs. \
4-
This extension is also intended to be used to quickly install the packages. Currently yaourt and \
5-
pacaur can be used. If you are missing your favorite AUR helper tool send a PR."""
3+
"""Query and install ArchLinux User Repository (AUR) packages.
4+
5+
You can search for packages and open their URLs. This extension is also intended to be used to \
6+
quickly install the packages. If you are missing your favorite AUR helper tool send a PR.
7+
8+
Synopsis: <trigger> <pkg_name>"""
69

710
from albertv0 import *
811
from shutil import which

‎base_converter.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# -*- coding: utf-8 -*-
22

33
"""Convert representations of numbers.
4-
Usage: base <src base> <dest base> <number>
5-
Or: <src base name> <number> [padding]
6-
Examples: base 10 16 1234567890
7-
dec 1024
8-
hex 5f 8"""
94
10-
from albertv0 import *
5+
Synopsis:
6+
<trigger> <src base> <dest base> <src>
7+
<bin|oct|dec|hex> <number> [padding]"""
8+
119
import numpy as np
1210

11+
from albertv0 import *
12+
1313
__iid__ = "PythonInterface/v0.1"
1414
__prettyname__ = "Base Converter"
1515
__version__ = "1.1"

‎binance/__init__.py‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# -*- coding: utf-8 -*-
22

3-
"""Quickly access the Binance markets. You can either search the items directly by typing the \
4-
market name, e.g. xrpbtc, or list and filter markets by using the trigger and filter, e.g 'bnc \
5-
[filter]'"""
3+
"""Access the Binance markets.
4+
5+
Synopsis:
6+
filter
7+
<trigger> [filter]"""
68

79
from albertv0 import *
810
import time

‎bitfinex/__init__.py‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# -*- coding: utf-8 -*-
22

3-
"""Quickly access the Bitfinex markets. You can either search the items directly by typing the \
4-
market name, e.g. xrpbtc, or list and filter the markets by using the trigger and filter, e.g \
5-
'bfx [filter]'"""
3+
"""Access the Bitfinex markets.
4+
5+
Synopsis:
6+
filter
7+
<trigger> [filter]"""
68

79
from albertv0 import *
810
import time

‎coinmarketcap/__init__.py‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# -*- coding: utf-8 -*-
22

3-
"""Show and access crypto currencies on CoinmMarketCap.com. For max readability the units are \
4-
omitted. The values of "Change" are the hourly, daily and weekly changes of the price in percent. \
5-
"Cap" is the market capitalisation in USD. Volume is the volume of the last 24 hours in USD."""
3+
"""Show and access crypto currencies on CoinmMarketCap.com.
4+
5+
The values of "Change" are the hourly, daily and weekly changes of the price in percent. "Cap" is \
6+
the market capitalisation in USD. Volume is the volume of the last 24 hours in USD.
7+
8+
Synopsis: <trigger> [filter]"""
69

710
from albertv0 import *
811
from threading import Thread, Event

‎copyq.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# -*- coding: utf-8 -*-
22

3-
"""CopyQ clipboard management."""
3+
"""Access CopyQ clipboard.
4+
5+
Synopsis: <trigger> [filter]"""
46

57
import html
68
import json

‎currency_converter.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
"""Convert currencies.
44
5+
Current backends: ECB, Yahoo.
6+
57
Synopsis: <amount> <src currency> [to|as|in] <dest currency>"""
68

79
import re

0 commit comments

Comments
 (0)