-
Notifications
You must be signed in to change notification settings - Fork 281
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 lightly/models/modules #1700
Add Documentation for lightly/models/modules #1700
Conversation
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.
Great work, well done!
Just one note about style: Explanations of args go in another line, see the example file. This makes it more readable, especially for longer explanations.
@MalteEbner I've done the instructed changes. Also, the file lightly/models/modules/heads.py fails to format when I run the make format command with the message "unindent does not match any outer indentation level (, line 362)" |
536a4a7
to
166a46a
Compare
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.
Looks perfect now, thanks a lot!
I quickly fixed the wrong indent of the docstring for the SMoGPrototypes
and formatted the file, it is ready to merge now.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1700 +/- ##
=======================================
Coverage 84.86% 84.86%
=======================================
Files 155 155
Lines 6508 6508
=======================================
Hits 5523 5523
Misses 985 985 ☔ View full report in Codecov by Sentry. |
#1687
I have updated the docstrings for the following files: