Skip to content

Commit

Permalink
Add missing information to manpages
Browse files Browse the repository at this point in the history
Also:
- Updated description of command 'mblookup'
- Misc text changes

Signed-off-by: JoeLametta <[email protected]>
  • Loading branch information
JoeLametta committed Feb 14, 2021
1 parent 9142578 commit 87f3d00
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 13 deletions.
10 changes: 9 additions & 1 deletion man/whipper-cd-rip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Rips a CD
---------

:Author: Louis-Philippe Véronneau
:Date: 2020
:Date: 2021
:Manual section: 1

Synopsis
Expand Down Expand Up @@ -61,6 +61,14 @@ Options
| **--cdr**
| whether to continue ripping if the disc is a CD-R
| **-C** | **--cover-art** *file embed complete*
| Fetch cover art and save it as standalone file, embed into FLAC files or
| perform both actions: file, embed, complete option values respectively
| **-r** | **--max-retries** *<RETRIES>*
| Number of rip attempts before giving up if can't rip a track. This
| defaults to 5; 0 means infinity.
Template schemes
================

Expand Down
14 changes: 7 additions & 7 deletions man/whipper-mblookup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@
whipper-mblookup
================

----------------------------------------------------
Look up a MusicBrainz disc id and output information
----------------------------------------------------
-------------------------------------------------------------------------
Look up either a MusicBrainz Disc ID or Release ID and output information
-------------------------------------------------------------------------

:Author: Louis-Philippe Véronneau
:Date: 2020
:Date: 2021
:Manual section: 1

Synopsis
========

| whipper mblookup *<MB_DISC_ID>*
| whipper mblookup *<MB_ID>*
| whipper mblookup **-h**
Arguments
=========

| *<MB_DISC_ID>* MusicBrainz disc id to look up
| *<MB_ID>* MusicBrainz Disc ID or Release ID to look up
Options
=======
Expand All @@ -30,7 +30,7 @@ Options
Examples
========

You can lookup a MusicBrainz disc id and output its information this way::
You can lookup a MusicBrainz Disc ID and output its information this way::

whipper mblookup KnpGsLhvH.lPrNc1PBL21lb9Bg4-

Expand Down
11 changes: 6 additions & 5 deletions whipper/command/mblookup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,16 @@

class MBLookup(BaseCommand):
summary = "lookup MusicBrainz entry"
description = """Look up a MusicBrainz disc id and output information.
description = """Look up either a MusicBrainz Disc ID or Release ID and output information.
You can get the MusicBrainz disc id with whipper cd info.
You can get the MusicBrainz Disc ID with whipper cd info.
Example disc id: KnpGsLhvH.lPrNc1PBL21lb9Bg4-"""
Example Disc ID: KnpGsLhvH.lPrNc1PBL21lb9Bg4-"""

def add_arguments(self):
self.parser.add_argument(
'mbid', action='store', help="MB disc id or release id to look up"
'mbid', action='store',
help="MusicBrainz Disc ID or Release ID to look up"
)

def _printMetadata(self, md):
Expand Down Expand Up @@ -44,7 +45,7 @@ def do(self):
try:
mbid = str(self.options.mbid.strip())
except IndexError:
print('Please specify a MusicBrainz disc id or release id.')
print('Please specify a MusicBrainz Disc ID or Release ID.')
return 3

releaseIdMatch = re.match(
Expand Down

0 comments on commit 87f3d00

Please sign in to comment.