From 6c64ab6df157a6f335d0a072d30b167eb4bc5c34 Mon Sep 17 00:00:00 2001 From: patrick-nicholson Date: Mon, 27 Dec 2021 12:11:18 -0500 Subject: [PATCH] Noticed GitHub linter wanted a docstring. --- beetsplug/limit.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/beetsplug/limit.py b/beetsplug/limit.py index 6dfb2c40d..5e5ee16be 100644 --- a/beetsplug/limit.py +++ b/beetsplug/limit.py @@ -11,6 +11,15 @@ # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. +"""Adds head/tail functionality to list/ls. + +1. Implemented as `lslimit` command with `--head` and `--tail` options. This is + the idiomatic way to use this plugin. +2. Implemented as query prefix `<` for head functionality only. This is the + composable way to use the plugin (plays nicely with anything that uses the + query language). +""" + from beets.dbcore import FieldQuery from beets.plugins import BeetsPlugin from beets.ui import Subcommand, decargs, print_