Merged
Conversation
Member
Author
|
Note that these docs already reflect changes in #6044 |
JukkaL
reviewed
Dec 12, 2018
Collaborator
JukkaL
left a comment
JukkaL
left a comment
There was a problem hiding this 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.
msullivan
reviewed
Dec 12, 2018
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. |
JukkaL
approved these changes
Dec 13, 2018
Collaborator
JukkaL
left a comment
JukkaL
left a comment
There was a problem hiding this 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.