-
Notifications
You must be signed in to change notification settings - Fork 11
fix documentation build, misc bugs and add doctests #44
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
Conversation
def5c17 to
07b4b28
Compare
94706f5 to
595df07
Compare
48d9531 to
6952021
Compare
|
@esabo, The PR is ready review, Thank you! P.S. Added more doctests as well. |
09168c6 to
7fbf902
Compare
esabo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So I guess one question is whether or not we want to move these doc tests to tutorials or actual docs and out of the doc strings themselves?
|
I think tutorials require documentation about the code itself as well as seen from other tutorials. I think we can have docstrings in the tutorial as well once we write about weight reduction for example. There seems to be a bug, I have reported it to HQ. I think even MethodTypingSignature didn't removed the warnings: Documentation build passes now most of the time, as seen from actions, it's the build runner CI sometime didn't run so the error this time. |
|
I'd like to get this pulled in. What's the status of this? |
|
LGTM as documentation build passes. |
This PR aims to fix documentation build, misc bugs and add doctests.