Fix bug + Add Tests + Enhance docstrings (shape_equal) #751
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
Faisal-Alsrheed
changed the title
Faisal-Alsrheed
changed the title
Faisal-Alsrheed
changed the title
Faisal-Alsrheed
changed the title
Faisal-Alsrheed
changed the title
Faisal-Alsrheed
changed the title
|
Hi @fchollet :) Which Python function docstring standard does the Keras team use? Please recommend a python library for docstring. Black is not working with docstring as far as u know. I can not find any information This ? Thank you |
fchollet
reviewed
Aug 19, 2023
You can copy/paste code snippets into a black formatting tool, there are webpages that can do it. |
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.
Bug Fix:
In
shape_equalfunction, usingaxis=1resulted in theerror: TypeError: 'int' object is not iterable.but
axis=[1]worked correctly.After hours of trying :) the issue has been resolved, and now an integer, list, or tuple of integers work as expected and documented.
Improved Docstrings:
The documentation for the shape_equal function has been enhanced. It now provides a more in-depth description and includes illustrative examples.
Additional Tests:
A new set of tests has been added to ensure the proper functionality of the
shape_equalfunction.Why do we need tests for the
shape_equalfunction? Because there are 7 other functions depend on it:Please share your feedback, thank you for the guidance, I am learning so much :)