-
Notifications
You must be signed in to change notification settings - Fork 284
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
[ADD] Documentation for data validation and preprocessing #323
Conversation
Codecov Report
@@ Coverage Diff @@
## development #323 +/- ##
===============================================
- Coverage 82.01% 81.98% -0.04%
===============================================
Files 151 152 +1
Lines 8652 8669 +17
Branches 1322 1325 +3
===============================================
+ Hits 7096 7107 +11
- Misses 1088 1094 +6
Partials 468 468
Continue to review full report at Codecov.
|
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.
Thanks for the PR.
I put comments except docs/manual.rst
.
docs/manual.rst looks good to me, so I will wait for your commits. |
Co-authored-by: nabenabe0928 <47781922+nabenabe0928@users.noreply.github.com>
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.
I think we can delete default
?
You can check which file has (xxx), (default=xxx)
by find -name "*.py" -exec grep ", (default" {} \; -print | grep "./"
.
I also found out that some of them have the default value of None
while the typing says xxx
, but not Optional[xxx]
.
Co-authored-by: nabenabe0928 <47781922+nabenabe0928@users.noreply.github.com>
I have unified the way we document types throughout the project. I have also fixed type information to |
Addresses #319 .
Also, fixes formatting issues which were caused by improper indentation.