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

feature: Option to hide implementation signature in case of overloads #213

Open
pawamoy opened this issue Dec 3, 2024 · 0 comments
Open
Assignees
Labels
feature New feature or request fund Issue priority can be boosted insiders Candidate for Insiders

Comments

@pawamoy
Copy link
Member

pawamoy commented Dec 3, 2024

Is your feature request related to a problem? Please describe.

See #182 (comment). Implementations often combine all parameters and their types together and can be hard to read, compared to overloads with their clean signatures.

Describe the solution you'd like

An option to hide the implementation signature and only render the overloads.

With separated signatures, easy, just render the overloads, then the docstring of the implementation (or something else depending on how overloads rendering evolves).

With signatures in heading, just don't render the implementation signature in the heading.

Describe alternatives you've considered

Overriding templates, but our templates and their blocks still not allow lightweight customization. They often require to copy-paste big blocks of Jinja code, which in the long-term is not great for maintenance (no easy way to get recent updates while maintaining your own changes).

Additional context

/

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
@pawamoy pawamoy added feature New feature or request insiders Candidate for Insiders fund Issue priority can be boosted labels Dec 3, 2024
@pawamoy pawamoy self-assigned this Dec 3, 2024
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

1 participant