Added documentation and some (review) comments for selected classes #2
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
focused mostly on the OT implementation and dependencies.
lumip
force-pushed
the
documentation-and-review-comments
branch
from
de4a5e6
to
b3a1b56
Compare
…Transfer interfaces.
… resolved/discussed comments and fixed docstring formats where necessary.
lumip
changed the title
|
I will leave this pull request open since the documented classes are currently very likely to be subject to change. The documentation is merged as soon as the codebase is stable enough so that it is clear that the respective classes will be part of the final API. |
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.
focused mostly on the OT implementation and dependencies/utility for now.
I opened the PR to enable discussion about some of the notes and comments I made, however, this is an ongoing process and should not yet be merged.