Skip to content

Support attribute docstrings #489

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
Closed
wants to merge 1 commit into from
Closed

Support attribute docstrings #489

wants to merge 1 commit into from

Conversation

mxr
Copy link
Member

@mxr mxr commented May 20, 2020

Resolves #159

@asottile
Copy link
Member

thanks for the patch!

I'm a little torn on this since I think it's ~slightly better to use comments than strings: #159 (comment) (and I'm pretty sure they work?)

@mxr
Copy link
Member Author

mxr commented May 20, 2020

Happy to close it if there's a workaround

@asottile
Copy link
Member

Happy to close it if there's a workaround

I would need to confirm that #: works -- I don't have a sphinx project of my own to test it on though 🤔

@mxr
Copy link
Member Author

mxr commented Mar 5, 2021

@asottile should we close this?

@mbukatov
Copy link

mbukatov commented Mar 5, 2021

Using a doc string instead of #: comment also allows to use rst syntax or explain the variable in multiple lines.

@asottile
Copy link
Member

asottile commented Mar 5, 2021

yeah I think I'll just close this

@asottile asottile closed this Mar 5, 2021
@mxr mxr deleted the docstring branch September 6, 2023 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

check-docstring-first false positive on attribute docstrings
3 participants
@mxr @asottile @mbukatov