-
-
Notifications
You must be signed in to change notification settings - Fork 49
Add option docstring_inherit_strategy
#195
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
Conversation
Working unit tests as well.
In mkdocs, a new paragraph will only appear if two newline characters are used, resulting in a completely empty line.
Hi @thomasmarwitz, thanks for the PR. It is however best to first discuss things in a discussion/issue before sending PRs. Are you sure you linked the right issue? #133 doesn't seem relevant to this PR. |
Hey @pawamoy, I meant #194, sorry for the confusion. And I'll remember for the next time :) I'm rather new to contributing to OSS. All remarks are appreciated! |
OK that's what I thought (just saw #194), thanks for the clarification 🙂 So, it's not an issue per-se to open a PR without having discussed the solution first, but you just risk wasting your time working on something that won't be accepted (and that puts maintainers in an awkward position 😅). What I would have answered on #194 is that we already support the We're starting to have lots of config options in mkdocstrings-python, and new ones must be added very, very carefully. |
Thanks for your kind and explaining answer @pawamoy. I looked into the griffe extension, that seems awesome! I'll start porting my work there. And thanks in general for providing dozens of helpful libraries 😃! Through this project, I also came in touch with |
Add
docstring_merge_delimiter
as well to control the concatenation during merging docstrings.This PR addresses #194
Todo:
✗ Checking for API breaking changes (1)
=> this is expected as the default config has been expanded