Skip to content

Commit c1a76b7

Browse files
committed
Complete docstring of parse_branches
1 parent ed4a714 commit c1a76b7

File tree

1 file changed

+10
-1
lines changed
  • readthedocs/vcs_support/backends

1 file changed

+10
-1
lines changed

readthedocs/vcs_support/backends/hg.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,16 @@ def branches(self):
4646
return self.parse_branches(stdout)
4747

4848
def parse_branches(self, data):
49-
"""Stable / default"""
49+
"""
50+
Parses output of `hg branches --quiet`, eg:
51+
52+
default
53+
0.2
54+
0.1
55+
56+
Into VCSVersion objects with branch name as verbose_name and
57+
identifier.
58+
"""
5059
names = [name.lstrip() for name in data.splitlines()]
5160
return [VCSVersion(self, name, name) for name in names if name]
5261

0 commit comments

Comments
 (0)