Skip to content

gh-112205: Support docstring for @getter #113160

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

Merged
corona10 merged 12 commits into from
Dec 20, 2023
Merged

gh-112205: Support docstring for @getter #113160

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e9c9949
gh-112205: Support docstring for `@getter`
corona10 Dec 15, 2023
bc2ee26
Resolve regression
corona10 Dec 15, 2023
cf1a3a5
nit
corona10 Dec 15, 2023
61bcbb3
Merge branch 'main' into gh-112205-doc
erlend-aasland Dec 19, 2023
6bb8272
Update Tools/clinic/clinic.py
corona10 Dec 19, 2023
c1b6901
Address code review
corona10 Dec 19, 2023
9a021ae
Address code review
corona10 Dec 19, 2023
2cffe25
nit style
corona10 Dec 19, 2023
18d1786
nit
corona10 Dec 19, 2023
cb6f499
Update Lib/test/test_clinic.py
corona10 Dec 19, 2023
5476431
Improve readblility
corona10 Dec 20, 2023
15d61e9
Update Tools/clinic/clinic.py
corona10 Dec 20, 2023
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
Prev Previous commit
Next Next commit
Address code review
  • Loading branch information
@corona10
corona10 committed Dec 19, 2023
commit c1b6901f528fba88cfe052aa248aa2fe529a5593
2 changes: 1 addition & 1 deletion Lib/test/test_clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2233,7 +2233,7 @@ class Foo "" ""
bar
[clinic start generated code]*/
"""
expected_error = "@setter can not set docstring"
expected_error = "docstrings are only supported for @getter, not @setter"
self.expect_failure(block, expected_error)

def test_duplicate_getset(self):
Expand Down
12 changes: 7 additions & 5 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6280,6 +6280,7 @@ def format_docstring_signature(
if self.forced_text_signature:
add(self.forced_text_signature)
elif f.kind in {GETTER, SETTER}:
# @getter and @setter do not need signatures like a method or a function.
return ''
Comment thread
corona10 marked this conversation as resolved.
else:
add('(')
Expand Down Expand Up @@ -6453,11 +6454,12 @@ def format_docstring_parameters(params: list[Parameter]) -> str:
def format_docstring(self) -> str:
assert self.function is not None
f = self.function
if f.kind.new_or_init and not f.docstring:
# don't render a docstring at all, no signature, nothing.
return f.docstring
if f.kind in {GETTER, SETTER} and not f.docstring:
# don't render a docstring at all, no signature, nothing.
k = f.kind
if (k.new_or_init or k in {GETTER, SETTER}) and not f.docstring:
# If the following methods have a empty docstring,
# Do not render a docstring at all, no signature, nothing.
# 1. __init__ / __new__
# 2. @getter / @setter properties
return f.docstring

# Enforce the summary line!
Expand Down