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

Add plugin docs #6057

Merged
merged 7 commits into from Dec 13, 2018

Conversation

Projects
None yet
3 participants
@ilevkivskyi
Copy link
Collaborator

ilevkivskyi commented Dec 11, 2018

This adds documentation for the plugin system. To avoid duplication, I add shorter and more basic info to the docs, while adding more technical details to the module/class/method docstrings.

To save time I would propose to make one-two rounds of review here and then polish the docs in subsequent PRs.

@ilevkivskyi ilevkivskyi requested a review from JukkaL Dec 11, 2018

@ilevkivskyi

This comment has been minimized.

Copy link
Collaborator Author

ilevkivskyi commented Dec 11, 2018

Note that these docs already reflect changes in #6044

@JukkaL
Copy link
Collaborator

JukkaL left a comment

Thanks for documenting this! Left a bunch of comments. Feel free to leave some suggestions unaddressed for now -- but we should address them before the next release. There are some other minor things I can change myself once this has been merged.

Show resolved Hide resolved docs/source/extending_mypy.rst Outdated
Show resolved Hide resolved docs/source/extending_mypy.rst Outdated
Show resolved Hide resolved docs/source/extending_mypy.rst Outdated
Show resolved Hide resolved docs/source/extending_mypy.rst Outdated
Show resolved Hide resolved docs/source/extending_mypy.rst Outdated
Show resolved Hide resolved mypy/plugin.py Outdated
Show resolved Hide resolved mypy/plugin.py
Show resolved Hide resolved mypy/plugin.py Outdated
Show resolved Hide resolved mypy/plugin.py
Show resolved Hide resolved mypy/plugin.py Outdated
Show resolved Hide resolved docs/source/extending_mypy.rst Outdated
Show resolved Hide resolved docs/source/extending_mypy.rst Outdated
Show resolved Hide resolved docs/source/extending_mypy.rst
Show resolved Hide resolved docs/source/extending_mypy.rst Outdated

Ivan Levkivskyi added some commits Dec 12, 2018

@ilevkivskyi

This comment has been minimized.

Copy link
Collaborator Author

ilevkivskyi commented Dec 12, 2018

@JukkaL @msullivan I made practically all changes you requested. Please take a look once more and then I would propose to merge this.

@JukkaL

JukkaL approved these changes Dec 13, 2018

Copy link
Collaborator

JukkaL left a comment

Thanks for the updates! LGTM now. I'll prepare a PR that does some minor updates that are too inefficient to implement through code review.

@ilevkivskyi ilevkivskyi merged commit 36fcf4f into python:master Dec 13, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@ilevkivskyi ilevkivskyi deleted the ilevkivskyi:add-plugin-docs branch Dec 13, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment