Skip to content

Commit b1c69a3

Browse files
committed
cmd(hg): pydocstyle manual fixes
1 parent 6dde4a0 commit b1c69a3

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

src/libvcs/cmd/hg.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
"""
1+
"""Run hg (Mercurial) commands directly against a local mercurial repo.
2+
23
.. Note::
34
45
At a Mercurial shop? Can you help us jimmy this module into the next `Sunbeam toaster
@@ -19,6 +20,8 @@
1920

2021

2122
class HgColorType(enum.Enum):
23+
"""CLI Color enum for Mercurial."""
24+
2225
boolean = "boolean"
2326
always = "always"
2427
auto = "auto"
@@ -27,13 +30,17 @@ class HgColorType(enum.Enum):
2730

2831

2932
class HgPagerType(enum.Enum):
33+
"""CLI Pagination enum for Mercurial."""
34+
3035
boolean = "boolean"
3136
always = "always"
3237
auto = "auto"
3338
never = "never"
3439

3540

3641
class Hg:
42+
"""Run commands directly on a Mercurial repository."""
43+
3744
progress_callback: Optional[ProgressCallbackProtocol] = None
3845

3946
def __init__(
@@ -64,6 +71,7 @@ def __init__(
6471
self.progress_callback = progress_callback
6572

6673
def __repr__(self) -> str:
74+
"""Representation of Mercurial Repo command object."""
6775
return f"<Hg dir={self.dir}>"
6876

6977
def run(
@@ -89,7 +97,8 @@ def run(
8997
check_returncode: Optional[bool] = None,
9098
**kwargs: Any,
9199
) -> str:
92-
"""
100+
"""Run a command for this Mercurial repository.
101+
93102
Passing None to a subcommand option, the flag won't be passed unless otherwise
94103
stated.
95104

0 commit comments

Comments
 (0)