feat: allow force_inspection option to be configurable#231
feat: allow force_inspection option to be configurable#231pawamoy merged 3 commits intomkdocstrings:mainfrom
force_inspection option to be configurable#231Conversation
force_inspection option to be configurable
|
Hi @elfkuzco, thank you so much for the PR! I have edited the body to mention that it fixes #94 🙂 Could you revert the style changes? It looks like your IDE formatted the code with a 80 width. You can run |
Oh, I am glad it resolves another issue. I only stumbled on it while working on an issue on another project and this seemed to be the easiest way. Should I set |
88ab0d9 to
ac1cfa4
Compare
No, our Ruff config is in |
I actually use Vim and not VSCode. I added the line-length to my local pyproject.toml (but didn't add it to the changes) and while it reverts some of the changes in this file, it leaves some as it is. I tried copying the changes and pasting them back but it keeps fixing them. Even some of the lines with |
|
Well I'd recommend disabling auto-formatting for this project then. Or configuring Vim so it runs Ruff with |
ac1cfa4 to
bc51394
Compare
Okay. Looks good now. |
|
Thank you! I've merged main to fix CI, and also added a docs entry for the new option. |
Griffe supports this option but mkdocstrings-python didn't allow users to configure it. Issue-94: mkdocstrings/python#94 PR-231: mkdocstrings/python#231
Add
force_inspectionflag toPythonHandlerformkdocs.ymlconfigurationRationale
The
force_inspectionargument cannot be configured directly viamkdocs.yml. This change introduces a straightforward way to pass the option by forwarding it to theGriffeLoader.Changes
force_inspectiontoPythonHandler.default_configwith a default value ofFalse.force_inspectionvalue to theGriffeLoaderconstructor.Fixes #94