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

Support new mkdocstrings_handlers namespace #367

Merged
merged 2 commits into from Feb 5, 2022

Conversation

pawamoy
Copy link
Member

@pawamoy pawamoy commented Feb 1, 2022

No description provided.

@pawamoy pawamoy force-pushed the find-handlers-in-mkdocstrings_handlers branch from 0aad9b2 to b8e73d7 Compare February 1, 2022 20:44
@pawamoy pawamoy mentioned this pull request Feb 3, 2022
31 tasks
@pawamoy
Copy link
Member Author

pawamoy commented Feb 3, 2022

Lets not emit deprecation warnings for our own legacy handler. Users don't care about them.

@pawamoy
Copy link
Member Author

pawamoy commented Feb 3, 2022

@oprypin do you want us not to emit these deprecation warnings for the crystal handler as well?

@oprypin
Copy link
Member

oprypin commented Feb 3, 2022

@pawamoy Well yes but that will just be done by making the handler use the new approach

@pawamoy
Copy link
Member Author

pawamoy commented Feb 4, 2022

Indeed, it's just in case you don't plan to upgrade your handler immediately and don't want to bother your users with a deprecation warning they have no control over. Let me know.

@@ -42,7 +40,7 @@ See the documentation for
[`BaseRenderer`][mkdocstrings.handlers.base.BaseRenderer].

Check out how the
[Python handler](https://github.com/pawamoy/mkdocstrings/blob/master/src/mkdocstrings/handlers/python.py)
[Python handler](https://github.com/mkdocstrings/python/blob/master/src/mkdocstrings_handlers/python)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#356 will remove this destination though

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm no I think it's right: this link points to the extracted Python handler, i.e. its own repository in the org, and not mkdocstrings' repo.

@pawamoy pawamoy force-pushed the find-handlers-in-mkdocstrings_handlers branch from f9cd116 to 2b6561c Compare February 5, 2022 12:28
@pawamoy pawamoy merged commit d5d5f18 into master Feb 5, 2022
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

Successfully merging this pull request may close these issues.

None yet

2 participants