-
Notifications
You must be signed in to change notification settings - Fork 28
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
Update documentation #283
Merged
Merged
Update documentation #283
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
I don't want this part of the core lib (yet), may add it back later once we reach some more stability
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #283 +/- ##
==========================================
+ Coverage 58.47% 61.33% +2.85%
==========================================
Files 56 56
Lines 4918 4717 -201
==========================================
+ Hits 2876 2893 +17
+ Misses 2042 1824 -218 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
Pretty much closes #278 |
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.
One of the main remaining items for V4 is/was documentation. In this PR, I've setup some infra changes to make publishing new documentation pieces easier and also added some documentation to certain classes and methods.
Additionally, with the goal of moving away from the wiki (for various reasons), this PR contains some of the getting started code that used to be in the wiki, directly in the Python docs.
I've also moved and shifted around some of the main init import logic and made certain classes not available top-level. Let's see if that gives us any issues down the line.