Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[pydoclint] Add support for Sphinx-style docstrings in the pydoclint rules. #13286

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

[pydoclint] Add support for Sphinx-style docstrings in the pydoclint rules. #13286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
049fb7d
add support for sphinx docstring
augustelalande Sep 8, 2024
52db1b0
clippy
augustelalande Sep 8, 2024
c790e03
correctly extract section_name from sphinx docstring
augustelalande Sep 10, 2024
e52d8d3
improve detection of sphinx sections
augustelalande Sep 10, 2024
2c33605
clippy
augustelalande Sep 10, 2024
4ad0765
properly gate changes
augustelalande Sep 28, 2024
040dab7
clippy
augustelalande Sep 28, 2024
d63e873
forgot to run review
augustelalande Sep 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions crates/ruff_linter/resources/test/fixtures/pydoclint/DOC201_sphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# DOC201
def foo(num: int) -> str:
"""
Do something

:param num: A number
:type num: int
"""
return 'test'


# OK
def foo(num: int) -> str:
"""
Do something

:param num: A number
:type num: int
:return: A string
:rtype: str
"""
return 'test'


class Bar:

# OK
def foo(self) -> str:
"""
Do something

:param num: A number
:type num: int
:return: A string
:rtype: str
"""
return 'test'


# DOC201
def bar(self) -> str:
"""
Do something

:param num: A number
:type num: int
"""
return 'test'


# OK
@property
def baz(self) -> str:
"""
Do something

:param num: A number
:type num: int
"""
return 'test'
48 changes: 48 additions & 0 deletions crates/ruff_linter/resources/test/fixtures/pydoclint/DOC202_sphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# OK
def foo(num: int) -> str:
"""
Do something

:param num: A number
:type num: int
"""
print('test')


# DOC202
def foo(num: int) -> str:
"""
Do something

:param num: A number
:type num: int
:return: A string
:rtype: str
"""
print('test')


class Bar:

# DOC202
def foo(self) -> str:
"""
Do something

:param num: A number
:type num: int
:return: A string
:rtype: str
"""
print('test')


# OK
def bar(self) -> str:
"""
Do something

:param num: A number
:type num: int
"""
print('test')
126 changes: 126 additions & 0 deletions crates/ruff_linter/resources/test/fixtures/pydoclint/DOC402_sphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# DOC402
def foo(num: int) -> str:
"""
Do something

:param num: A number
:type num: int
"""
yield 'test'


# OK
def foo(num: int) -> str:
"""
Do something

:param num: A number
:type num: int
:yield: A string
:rtype: str
"""
yield 'test'


class Bar:

# OK
def foo(self) -> str:
"""
Do something

:param num: A number
:type num: int
:yield: A string
:rtype: str
"""
yield 'test'


# DOC402
def bar(self) -> str:
"""
Do something

:param num: A number
:type num: int
"""
yield 'test'


import typing


# OK
def foo() -> typing.Generator[None, None, None]:
"""
Do something
"""
yield None


# OK
def foo() -> typing.Generator[None, None, None]:
"""
Do something
"""
yield


# DOC402
def foo() -> typing.Generator[int | None, None, None]:
"""
Do something
"""
yield None
yield 1


# DOC402
def foo() -> typing.Generator[int, None, None]:
"""
Do something
"""
yield None


# OK
def foo():
"""
Do something
"""
yield None


# OK
def foo():
"""
Do something
"""
yield


# DOC402
def foo():
"""
Do something
"""
yield None
yield 1


# DOC402
def foo():
"""
Do something
"""
yield 1
yield


# DOC402
def bar() -> typing.Iterator[int | None]:
"""
Do something
"""
yield
91 changes: 91 additions & 0 deletions crates/ruff_linter/resources/test/fixtures/pydoclint/DOC403_sphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# OK
def foo(num: int) -> str:
"""
Do something

:param num: A number
:type num: int
"""
print('test')


# DOC403
def foo(num: int) -> str:
"""
Do something

:param num: A number
:type num: int
:yield: A string
:rtype: str
"""
print('test')


class Bar:

# DOC403
def foo(self) -> str:
"""
Do something

:param num: A number
:type num: int
:yield: A string
:rtype: str
"""
print('test')


# OK
def bar(self) -> str:
"""
Do something

:param num: A number
:type num: int
"""
print('test')


import typing


# OK
def foo() -> typing.Generator[None, None, None]:
"""
Do something

:yield: When X.
"""
yield None


# OK
def foo() -> typing.Generator[None, None, None]:
"""
Do something

:yield: When X.
"""
yield


# OK
def foo():
"""
Do something

:yield: When X.
"""
yield None


# OK
def foo():
"""
Do something

:yield: When X.
"""
yield
Loading
Loading