Improve documentation of operations module
#2081
Merged
Conversation
This file contains 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
This only adds placeholder documentation for the module, as I'm rather sure that insertion is going to change at some point, so documenting it thoroughly is probably not worth the effort right now.
I've only added placeholder documentation for the module, as I'm about to make some pretty significant changes to it. I intend to add documentation afterwards.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Restructure the
operationsmodule, making its sub-modules public and adding documentation for each. The only module that is getting some "proper" documentation out of this so far isbuild, as all others are either fairly small or probably won't survive in their current form for much longer. However, this new structure provides the opportunity for improving the documentation of the other modules too in the future.