punk-security / dnsReaper

dnsReaper - subdomain takeover tool for attackers, bug bounty hunters and the blue team!
GNU Affero General Public License v3.0
1.93k stars 150 forks source link

style: Capitalize description of --help #85

Closed Engr-Asad-Hussain closed 1 year ago

Engr-Asad-Hussain commented 1 year ago

Found that the description of all inline options (arguments) is uniform except --help option. Capitalized the description of --help command also.

options:
-  -h, --help            show this help message and exit
+  -h, --help            Show this help message and exit
  --out OUT             Output file (default: results) - use 'stdout' to stream out
  --out-format {csv,json}
  --parallelism PARALLELISM
                        Number of domains to test in parallel - too high and you may see odd DNS results (default: 30)
  --disable-probable    Do not check for probable conditions
  --enable-unlikely     Check for more conditions, but with a high false positive rate
...
imnotbrandon commented 1 year ago

Hey, thanks for the contribution. Those options are defined in argparsing.py and we use the auto generated help output in the readme file. Could you update this in argparsing.py please?

Engr-Asad-Hussain commented 1 year ago

Hey, thanks for the contribution. Those options are defined in argparsing.py and we use the auto generated help output in the readme file. Could you update this in argparsing.py please?

Thanks @imnotbrandon. I will update argparsing.py file and push the changes.

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Engr-Asad-Hussain commented 1 year ago

Hey, @imnotbrandon hope you are doing well. I have just made a minor change in argparsing.py. The add_help=True is by default in class argparse.ArgumentParser that's why it was generating the --help description. I have added another argument that works same as --help command but with custom help description/details. I have also attached the console print as an jpg file. References 2

imnotbrandon commented 1 year ago

Because the commits are not signed, only an admin can merge this. @SimonGurney could you take a look please.

Engr-Asad-Hussain commented 1 year ago

@imnotbrandon Your Welcome!

SimonGurney commented 1 year ago

I can't merge either, @imnotbrandon can you pull the branch and squash into one signed commit?

imnotbrandon commented 1 year ago

I've had to squash and sign your commits because we only allow verified commits. You'll still get the contribution, however the pull request is now here: https://github.com/punk-security/dnsReaper/pull/90