Browse Source

update docstrings

shut
Niklas Rosenstein 10 months ago
parent
commit
0082852367
No known key found for this signature in database GPG Key ID: 6D269B33D25F6C6
4 changed files with 10 additions and 4 deletions
  1. + 3
    - 1
      src/shore/commands/commons/status.py
  2. + 3
    - 1
      src/shore/commands/mono/status.py
  3. + 1
    - 1
      src/shore/commands/pkg/__init__.py
  4. + 3
    - 1
      src/shore/commands/pkg/status.py

+ 3
- 1
src/shore/commands/commons/status.py

@ -36,7 +36,9 @@ def get_commits_since_last_tag(subject: Union[Monorepo, Package]):
def print_status(subject: Union[Monorepo, Package]) -> None:
"""
Prints the release status of a package or the packages in a monorepo.
The latest version is taken from the current version number in the package
configuration file. Git is then queried for the tag and the commit distance
to the current revision.
"""
items = [subject]

+ 3
- 1
src/shore/commands/mono/status.py

@ -24,6 +24,8 @@ from ..commons.status import print_status
import click
@mono.command()
@mono.command(help="""
Show which packages have been modified since their last release.
""" + print_status.__doc__)
def status():
print_status(load_monorepo_manifest())

+ 1
- 1
src/shore/commands/pkg/__init__.py

@ -24,7 +24,7 @@ from shore.model import Package
import click
@shut.group(help=__doc__)
@shut.group()
def pkg():
"""
Manage the Python package in the current directory.

+ 3
- 1
src/shore/commands/pkg/status.py

@ -24,6 +24,8 @@ from ..commons.status import print_status
import click
@pkg.command()
@pkg.command(help="""
Shows whether the package was modified since the last release.
""" + print_status.__doc__)
def status():
print_status(load_package_manifest())

Loading…
Cancel
Save