Improved Indentation and added Comments in the codebase. #133
Conversation
|
@mshudrak please check this |
|
Well, the pylint test is failing now. Could you remind me why do you want 4 spaces? |
|
@mshudrak ,in the review section, there is no showing pylint error for other files except |
|
I don't see that tests even run now. Additionally, this CL is too large for review. I'd advice you to split it per file. I also see a lot of comments you added to be redundant. See one I made for example. |
| @@ -14,5 +14,8 @@ | |||
| # See the License for the specific language governing permissions and | |||
| # limitations under the License. | |||
|
|
|||
| # Import the scanner module from the gcp_scanner package | |||
|
|
||
| # Call the main function of the scanner module to start the scanning process |
| @@ -16,7 +16,10 @@ | |||
|
|
|||
| """ | |||
|
|
|||
| # Importing the scanner module | |||
| if __name__ == '__main__': | ||
| # Calling the main function of the scanner module |
| @@ -20,6 +20,8 @@ | |||
| import argparse | |||
| import logging | |||
|
|
|||
|
|
|||
| # Define a function to create an argument parser using the argparse module | |||
| @@ -31,102 +33,117 @@ def arg_parser(): | |||
| argparse.Namespace: A namespace object containing the parsed command-line | |||
| arguments. | |||
| """ | |||
| # Create a new parser object | |||
There was a problem hiding this comment.
This is redundant. I am stopping on this one. You do not need to comment obvious sections of the code.
Yeah. I also thought that. Ok, I am working on it |
I think, can I close this issue. And start new PR fir group of 3 files. So that it can easy for check? |
|
Take a look at my other comments, a lot of comments are redundant. We do not need that level of comment details especially for obvious things. Also, we use 2 spaces instead of 4. |
|
Closing this one due to inactivity. Feel free to split it into small PRs and resubmit. |
Description
Fixes #117
Improved Indentation and added Comments in the codebase.
Please give wherever changes need.
Changes Made
[List the changes you have made in bullet points.]
Checklist
Related Issues
[If your changes relate to any existing issues, please list them here.]
Additional Notes
[Provide any additional notes or context that may be helpful for the reviewers.]
Feel free to modify and customize this template as needed to fit the specific needs of the GCP Scanner project.