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 request: option to override template in specific case #158

Open
tomerarnon opened this issue Oct 5, 2023 · 4 comments
Open

Feature request: option to override template in specific case #158

tomerarnon opened this issue Oct 5, 2023 · 4 comments

Comments

@tomerarnon
Copy link

Is it possible to override a set template for a particular docstring?

In particular, my template involves $TYPEDSIGNATURES, and in a couple of exceptional cases, I would rather omit those in favor of a more curated and brief list. Is it possible to do this?

@MichaelHatherly
Copy link
Member

Not possible to do. The only solution I can think of at the moment would be to maybe use a submodule that doesn't have a template set and put the ones you don't want to have use it in there instead. Not tried it, but might work from what I recall.

@tomerarnon
Copy link
Author

In that case, I'd like to make this a feature request to be able to override a template easily (e.g. with another abbreviation or something) 😅
Should I change the title to reflect or make a new issue and close this one?

@MichaelHatherly
Copy link
Member

Yes, please adjust the title. Unsure how it could be implemented, but likely something that could exist in some form since I can see it's usefulness.

@tomerarnon tomerarnon changed the title How to override template? Feature request: option to override template in specific case Oct 5, 2023
@tomerarnon
Copy link
Author

Maybe a macro or a different abbreviation at the top can be used to ignore the template? I haven't looked into any DocStringExtension internals, so I can't suggest anything concrete...

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

No branches or pull requests

2 participants