Skip to content

Commit 288d38e

Browse files
committed
Docstring written for run() function
1 parent fb838ab commit 288d38e

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/sphinxext/contributors.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ class ContributorsDirective(Directive):
2626
name = "contributors"
2727

2828
def run(self):
29+
"""
30+
Execute the contributors directive.
31+
32+
This method processes the provided revision range and generates the corresponding
33+
list of contributors.
34+
35+
Returns
36+
-------
37+
list
38+
A list of nodes representing the message indicating the number of contributors
39+
and commits, and a bullet list containing each contributor individually.
40+
"""
2941
range_ = self.arguments[0]
3042
if range_.endswith("x..HEAD"):
3143
return [nodes.paragraph(), nodes.bullet_list()]

0 commit comments

Comments
 (0)