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: De-duplicate summary sections when sections are written manually and auto-summaries are activated #134

Open
pawamoy opened this issue Feb 18, 2024 · 0 comments
Assignees
Labels
feature New feature or request

Comments

@pawamoy
Copy link
Member

pawamoy commented Feb 18, 2024

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

If I manually write an Attributes section, to give a specific order to attributes (or hide some of them), and I also activate the auto-summary option, I'll have two attributes sections rendered.

Describe the solution you'd like

Find a way to automatically de-duplicate sections: always keep the manually written ones. I suppose we can iterate on the object's docstring sections to check if there's already an attributes/function/etc. section.

Describe alternatives you've considered

Let the user handle it with the summary option. But this isn't fine-grained.

Additional context

Originally reported here: #133

@pawamoy pawamoy self-assigned this Feb 18, 2024
@pawamoy pawamoy added the feature New feature or request label Apr 13, 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
Projects
None yet
Development

No branches or pull requests

1 participant