Skip to content

Add Support For Attributes In Docstrings #160

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.

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
merged 2 commits into from
Nov 10, 2022
Merged

Conversation

HassanAbouelela
Copy link
Member

This allows class attributes to be defined in docstrings without causing an exception while linking the source code.

Due to the non-static nature of attributes, it's not trivial to link their actual definition, so the chosen lines will actually be all the lines of the parent class.

This resolves the issues experienced by #158. Thanks Chris for debugging this issue 😄

This allows class attributes to be defined in docstrings without causing
an exception while linking the source code.

Due to the non-static nature of attributes, it's not trivial to link
their actual definition, so the chosen lines will actually be all the
lines of the parent class.

Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
@HassanAbouelela HassanAbouelela added a: dependencies Pull requests which update a dependency file a: code Pull requests which add features, fixes, or any code change t: bug labels Nov 10, 2022
@netlify
Copy link

netlify bot commented Nov 10, 2022

Deploy Preview for bot-core ready!

Name Link
🔨 Latest commit a7e908a
🔍 Latest deploy log https://app.netlify.com/sites/bot-core/deploys/636d461de8788500093e30ab
😎 Deploy Preview https://deploy-preview-160--bot-core.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
@HassanAbouelela
Copy link
Member Author

Added in another quick change to bring the docs style more in-line with how it's supposed to look.

Before After
image image

@ChrisLovering ChrisLovering merged commit a6760a6 into main Nov 10, 2022
@ChrisLovering ChrisLovering deleted the fix-attributes branch November 10, 2022 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: code Pull requests which add features, fixes, or any code change a: dependencies Pull requests which update a dependency file t: bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants