-
Notifications
You must be signed in to change notification settings - Fork 18
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
Documentation improvements #5
Merged
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
ilan-tz
reviewed
Mar 27, 2022
Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>
ilan-tz
approved these changes
Mar 27, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
owners review ready
CODEOWNERS to review at earliest possible
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.
Context for changes
Major readthedocs improvements as listed below and some minor
README.md
updates.However, inheritance diagrams are still limited to what was instructed for classes in original Python files. See for example fp. codes the only package where two top classes were specified. See here and here for example on how to set up your classes for the best inheritance diagram experience.
README.md
doc/conf.py
,doc/dev_requirements.txt
, anddoc/Makefile
, among other minor file changes, to achieve the above.README.md
logos:Was replaced with Github-hosted links.
Example usage and tests
Performance results justifying changes
Workflow actions and tests
Expected benefits and drawbacks
Expected benefits:
B-
.Possible drawbacks:
Related Github issues
Checklist and integration statements
black
,docformatter
andpylint
configurations._version.py
based on semantic versioning. I recognize that the developers may create a Special Release including my changes. I suggest a Special Release PR is essential immediately following these changes.