Improved code style and fixed typos #1157
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
|
To ensure consistent code formatting, we use Black and isort. To auto-format the code, run the Add a Developer Certificate of Origin (DCO) to your commit. This certifies that you have the right to submit the code under an open-source license. How to write good commit messages? Refer to this guide: https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html |
michaelehab
force-pushed
the
better-code-style
branch
from
84543f2
to
55f9adc
Compare
Signed-off-by: Michael Ehab <[email protected]>
Signed-off-by: Michael Ehab <[email protected]>
Signed-off-by: Michael Ehab <[email protected]>
Signed-off-by: Michael Ehab <[email protected]>
Signed-off-by: Michael Ehab <[email protected]>
Signed-off-by: Michael Ehab <[email protected]>
Signed-off-by: Michael Ehab <[email protected]>
Signed-off-by: Michael Ehab <[email protected]>
To ensure consistent code formatting, I used Black and isort to format the changed files. Signed-off-by: Michael Ehab <[email protected]>
Fixed more typos and formated the files Signed-off-by: Michael Ehab <[email protected]>
michaelehab
force-pushed
the
better-code-style
branch
from
55f9adc
to
376ba41
Compare
keshav-space
requested changes
Mar 29, 2023
There was a problem hiding this comment.
Thanks @michaelehab
Use consistent format for docstring see comments below
…tone Changed the doctrings to have a consistent format and used Black and isort to format the changed files. Signed-off-by: Michael Ehab <[email protected]>
|
@keshav-space please review when you get chance |
keshav-space
requested changes
Dec 14, 2023
There was a problem hiding this comment.
Thanks, @michaelehab
See the few suggestions below, and also need to resolve the conflicts before we can merge this.
Signed-off-by: Keshav Priyadarshi <[email protected]>
Signed-off-by: Keshav Priyadarshi <[email protected]>
keshav-space
approved these changes
Jan 24, 2024
There was a problem hiding this comment.
Thanks @michaelehab
I have reverted some undesirable refactoring.
TG1999
pushed a commit
to TG1999/vulnerablecode
that referenced
this pull request
Jul 19, 2024
* style: modified snyk datasource file to follow pep 8 Signed-off-by: Michael Ehab <[email protected]> * style: modified osv datasource file to follow pep 8 Signed-off-by: Michael Ehab <[email protected]> * style: modified oss datasource file to follow pep 8 Signed-off-by: Michael Ehab <[email protected]> * style: modified vulnerablecode datasource file to follow pep 8 Signed-off-by: Michael Ehab <[email protected]> * style: modified gitlab datasource file to follow pep 8 Signed-off-by: Michael Ehab <[email protected]> * style: modified gitlab datasource file to follow pep 8 Signed-off-by: Michael Ehab <[email protected]> * style: modified deps.py file to follow pep 8 Signed-off-by: Michael Ehab <[email protected]> * Fixed some typos Signed-off-by: Michael Ehab <[email protected]> * Format code with Black and isort To ensure consistent code formatting, I used Black and isort to format the changed files. Signed-off-by: Michael Ehab <[email protected]> * Fix more typos in vulntotal tool Fixed more typos and formated the files Signed-off-by: Michael Ehab <[email protected]> * Use a consistent format for the docstring and maintain an imperative tone Changed the doctrings to have a consistent format and used Black and isort to format the changed files. Signed-off-by: Michael Ehab <[email protected]> * Handle TypeError and IndexError raised by get_item Signed-off-by: Keshav Priyadarshi <[email protected]> * Revert incorrect refactoring Signed-off-by: Keshav Priyadarshi <[email protected]> --------- Signed-off-by: Michael Ehab <[email protected]> Signed-off-by: Keshav Priyadarshi <[email protected]> Co-authored-by: Keshav Priyadarshi <[email protected]>
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.
What
I modified the datasources files to follow PEP 8 more closely. They were already following it but they missed some small details like the docstrings. I also fixed some typos found in the vulntotal_utils.py file and other files.
Why
I made these changes to improve the readability and consistency of the code. Following PEP 8 helps to maintain a high standard of code quality and style. Fixing typos helps to avoid confusion and errors.
Anything else
Please let me know if you have any questions or feedback. Thank you for reviewing my PR!