Skip to content

Commit

Permalink
✏️ Fix docstrings in spec
Browse files Browse the repository at this point in the history
Signed-off-by: rjdbcm <[email protected]>
  • Loading branch information
rjdbcm committed Jun 10, 2024
1 parent 77e5834 commit 235b16e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion ozi/comment.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,10 @@ def diagnostic( # pragma: no cover

def score_file(count: Counter[str]) -> float: # pragma: no cover
"""Score a single file comment diagnostic.
.. deprecated:: 1.11.2
Use :py:function:`ozi.comment.score` instead.
Use :py:func:`ozi.comment.score` instead.
"""
return score(count)

Expand Down
3 changes: 2 additions & 1 deletion ozi/spec/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@ def asdict(self: Self) -> dict[str, _Val[str]]:
Typing is compatible with :term:`JSON` and Jinja2 global namespace.
.. seealso::
:std:label:`jinja2:global-namespace`
:std:label:`jinja2:global-namespace`
"""
return dict(iter(self)) | {
'help': str(self.__class__.__doc__).replace('\n ', ''),
Expand Down

0 comments on commit 235b16e

Please sign in to comment.