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.

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

feat: Forward class attribute docstrings to instances. #135

Merged
merged 1 commit into from
Mar 3, 2023
Merged

feat: Forward class attribute docstrings to instances. #135

merged 1 commit into from
Mar 3, 2023

Conversation

rodrigogiraoserrao
Copy link
Contributor

This will fix #128.

Thanks for the guidance, @pawamoy.
I tried doing what was needed (follow commit message format conventions, add the test in the correct place, etc) but I might have missed something.
If so, please let me know.

Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's great, thanks a lot! 🚀

@pawamoy pawamoy merged commit 7bf4952 into mkdocstrings:master Mar 3, 2023
@pawamoy
Copy link
Member

pawamoy commented Mar 3, 2023

I've merged as "fix" rather than "feat".

@rodrigogiraoserrao
Copy link
Contributor Author

I've merged as "fix" rather than "feat".

Of course, sorry for getting that wrong.

@pawamoy
Copy link
Member

pawamoy commented Mar 4, 2023

Of course, sorry for getting that wrong.

Oh that's more a matter of opinion/maintenance rather than correctness, no worries 👍
"Fix" conveys that this is what we support, and not something else (previous behavior for example).

@rodrigogiraoserrao rodrigogiraoserrao deleted the fix-128 branch March 6, 2023 10:43
rodrigogiraoserrao added a commit to Textualize/textual that referenced this pull request Apr 24, 2023
rodrigogiraoserrao added a commit to Textualize/textual that referenced this pull request Apr 26, 2023
* First prototype of PB.

* Repurpose UnderlineBar.

* Factor out 'Bar' widget.

* Revert "Factor out 'Bar' widget."

This reverts commit 0bb4871.

* Add Bar widget.

* Cap progress at 100%.

* Add skeleton for the ETA label.

[skip ci]

* Add ETA display.

* Improve docstrings.

* Directly compute percentage.

* Watch percentage changes directly.

[skip ci]

* Documentation.

* Make reactive percentage private.

Instead, we create a public read-only percentage property.

* Update griffe to fix documentation issue.

Related issues: #1572, mkdocstrings/griffe#128.
Related PRs: mkdocstrings/griffe#135.

* Add example and docs.

* Address review feedback.

[skip ci]

* More documentation.

* Add tests.

* Changelog.

* More tests.

* Fix/fake tests.

* Final tweaks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Question: can I do anything about docstrings for attributes being picked up from last location
2 participants