Skip to content

Commit cc0a196

Browse files
author
Christian Knittl-Frank
committed
Typing fixes
1 parent ddd02b4 commit cc0a196

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

src/sphinxcontrib/scm/directives.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@
55
from docutils import nodes
66
from docutils.nodes import Node
77
from docutils.statemachine import StringList
8-
from sphinx.util import logging, nested_parse_with_titles
8+
from sphinx.util import logging
99
from sphinx.util.docutils import SphinxDirective
10+
from sphinx.util.nodes import nested_parse_with_titles
1011

1112
from .util import Helper
1213

1314
logger = logging.getLogger(f"sphinxcontrib-scm.{__name__}")
1415

1516

16-
class ContribsDirective(SphinxDirective, Helper):
17+
class ContribsDirective(Helper, SphinxDirective):
1718
has_content = False
1819
optional_arguments = 0
1920
option_spec = {
@@ -24,7 +25,7 @@ class ContribsDirective(SphinxDirective, Helper):
2425
"type": str,
2526
}
2627

27-
def run(self) -> Node:
28+
def run(self) -> list[Node]:
2829
"""Directive to list all SCM contributors"""
2930
contributors = self.get_contibutors()
3031
contributors_str = (

src/sphinxcontrib/scm/roles.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
logger = logging.getLogger(f"sphinxcontrib-scm.{__name__}")
1313

1414

15-
class ContribsRole(SphinxRole, Helper):
15+
class ContribsRole(Helper, SphinxRole):
1616
def run(self) -> tuple[list[Node], list[system_message]]:
1717
"""Role to list all SCM contributors"""
1818
contributors = self.get_contibutors()

src/sphinxcontrib/scm/util.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,22 @@
55

66
from docutils.parsers.rst import directives
77
from git.cmd import Git
8+
from sphinx.config import Config
89
from sphinx.util import logging
910

1011
logger = logging.getLogger(f"sphinxcontrib-scm.{__name__}")
1112

1213

1314
class Helper:
15+
options: dict
16+
17+
def get_source_info(self, lineno: int | None = None) -> tuple[str, int]:
18+
raise NotImplementedError
19+
20+
@property
21+
def config(self) -> Config:
22+
raise NotImplementedError
23+
1424
def get_contibutors(self) -> list[str]:
1525
"""Return list of Git contributors for given path using `git shortlog`
1626

0 commit comments

Comments
 (0)