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

Attrs Support #318

Open
LordOfPolls opened this issue Sep 17, 2021 · 11 comments
Open

Attrs Support #318

LordOfPolls opened this issue Sep 17, 2021 · 11 comments
Labels
feature New feature or request fund Issue priority can be boosted insiders Candidate for Insiders

Comments

@LordOfPolls
Copy link

LordOfPolls commented Sep 17, 2021

Is your feature request related to a problem? Please describe.
As of right now, this library does not support attrs dataclasses. Default values or types are not recognised.

Describe the solution you'd like
Attrs to be detected and their attributes documented correctly

Describe alternatives you've considered
Writing the documentation in the class docstring manually.

Additional context
Attrs: https://www.attrs.org/en/stable/

Boost priority

  • Boost priority in our backlog through Polar.sh. Higher pledge, higher priority.
  • Minimum pledge by user/organization is $5, minimum amount for boost is $30.
  • View all issues with pledges.
  • We receive the funds once the issue is completed and confirmed by you.
  • Features with the insiders label are released to sponsors first, and tied to a funding goal.
Fund with Polar
@LordOfPolls LordOfPolls added the feature New feature or request label Sep 17, 2021
@pawamoy
Copy link
Member

pawamoy commented Sep 17, 2021

As per #317 (comment), the new extractor will make it easy to write extensions to support third-party libs such as attrs.

@davfsa
Copy link
Contributor

davfsa commented Aug 1, 2022

Any chance to bump this? :)

@LordOfPolls
Copy link
Author

I attempted to implement an extension for Griffe. However it really needs to be a post processing extension.
To my knowledge this isn't possible yet

@pawamoy
Copy link
Member

pawamoy commented Aug 17, 2022

Thank you for giving it a try @LordOfPolls. Post-processing extensions are on the Griffe to do list 🙂
I'll also try to think a bit more about attrs support in particular.

@LordOfPolls
Copy link
Author

Hi @pawamoy, just checking in; has there been any movement on this?

@pawamoy
Copy link
Member

pawamoy commented Apr 12, 2023

Hey @LordOfPolls, no movement yet! But I've recently announced that I'm now working full-time on open source, so the development pace of mkdocstrings should greatly increase 🙂

@LordOfPolls
Copy link
Author

Oh neat, congratulations on the move. If attrs support became a insiders feature, i'd definitely jump on your sponsors list

@pawamoy pawamoy added fund Issue priority can be boosted insiders Candidate for Insiders labels Oct 22, 2024
@AdrianSosic
Copy link

Hi, is this extension still planned? Would be very much interested 🙃

@pawamoy
Copy link
Member

pawamoy commented Dec 10, 2024

Still planned!

@AdrianSosic
Copy link

Hi @pawamoy, great to hear. In this case, I'd also like to point you to here

@pawamoy
Copy link
Member

pawamoy commented Dec 10, 2024

Thanks @AdrianSosic, that's useful context!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request fund Issue priority can be boosted insiders Candidate for Insiders
Projects
None yet
Development

No branches or pull requests

4 participants