Skip to content

Commit

Permalink
🐛📝: fix documentation refs
Browse files Browse the repository at this point in the history
Signed-off-by: rjdbcm <[email protected]>
  • Loading branch information
rjdbcm committed Jun 17, 2024
1 parent b569a24 commit 284e8ab
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions ozi/comment.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def calculate_score(lines: int, t1: int, t2: int, t3: int) -> float: # pragma:
def pattern_cache(key: str) -> re.Pattern[str]: # pragma: no cover
"""Cached OZI specification linter comment pattern lookup.
:param key: key in :ref:`ozi.spec.CommentPatterns`
:param key: key in :py:class:`ozi.spec.CommentPatterns`
:type key: str
:return: compiled regular expression pattern
:rtype: re.Pattern[str]
Expand All @@ -109,7 +109,7 @@ def pattern_search(
:param line: line text verbatim
:type line: str
:yield: key, match for key in :ref:`ozi.spec.CommentPatterns` excluding ``help``
:yield: key, match for key in :py:class:`ozi.spec.CommentPatterns` excluding ``help``
:rtype: Generator[tuple[str, str], None, None]
"""
for key in METADATA.spec.python.src.comments.asdict().keys():
Expand Down
4 changes: 2 additions & 2 deletions ozi/spec/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,11 @@ def asdict(self: Self) -> dict[str, _Val[str]]:
"""Return a dictionary of all fields where repr=True.
Hide a variable from the dict by setting repr to False and using
a Default subclass as the default_factory.
Typing is compatible with :term:`JSON` and Jinja2 global namespace.
Typing is compatible with JSON and Jinja2 global namespace.
.. seealso::
:std:label:`jinja2:global-namespace`
:std:ref:`jinja2:global-namespace`
"""
return dict(iter(self)) | {
'help': str(self.__class__.__doc__).replace('\n ', ''),
Expand Down

0 comments on commit 284e8ab

Please sign in to comment.