Skip to content

Add plugin docs #6057

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

Merged
merged 7 commits into from
Dec 13, 2018
Merged

Add plugin docs #6057

merged 7 commits into from
Dec 13, 2018

Conversation

ilevkivskyi
Copy link
Member

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 December 11, 2018 23:39
@ilevkivskyi
Copy link
Member Author

Note that these docs already reflect changes in #6044

Copy link
Collaborator

@JukkaL JukkaL left a comment

Choose a reason for hiding this comment

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

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.

@ilevkivskyi
Copy link
Member Author

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

Copy link
Collaborator

@JukkaL JukkaL left a comment

Choose a reason for hiding this comment

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

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
@ilevkivskyi ilevkivskyi deleted the add-plugin-docs branch December 13, 2018 10:58
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.

3 participants