Skip to content

Commit b770f8d

Browse files
author
Tod Beardsley
committed
Land rapid7#5026, rapid7#5027, rapid7#5028: Doc grammar
This merge covers three PRs. It /should/ autoresolve rapid7#5026 and rapid7#5028, but I will have to manually close rapid7#5027 with this comment.
2 parents 613f477 + f663f39 commit b770f8d

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Thanks for your interest in making Metasploit -- and therefore, the
44
world -- a better place!
55

66
Are you about to report a bug? Sorry to hear it. Here's our [Issue tracker].
7-
Please try to be as specific as you can about your problem, include steps
8-
to reproduce (cut and paste from your console output if it's helpful), and
7+
Please try to be as specific as you can about your problem; include steps
8+
to reproduce (cut and paste from your console output if it's helpful) and
99
what you were expecting to happen.
1010

1111
Are you about to report a security vulnerability in Metasploit itself?
@@ -18,7 +18,7 @@ Metasploit module? If so, read on...
1818

1919
# Contributing to Metasploit
2020

21-
What you see here in CONTRIBUTING.md is a bullet-point list of the do's
21+
What you see here in CONTRIBUTING.md is a bullet point list of the do's
2222
and don'ts of how to make sure *your* valuable contributions actually
2323
make it into Metasploit's master branch.
2424

@@ -27,7 +27,7 @@ closed. Sorry!
2727

2828
This is intended to be a **short** list. The [wiki] is much more
2929
exhaustive and reveals many mysteries. If you read nothing else, take a
30-
look at the standard [development environment setup] guide,
30+
look at the standard [development environment setup] guide
3131
and Metasploit's [Common Coding Mistakes].
3232

3333
## Code Contributions
@@ -52,7 +52,7 @@ Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow.
5252
#### New Modules
5353

5454
* **Do** run `tools/msftidy.rb` against your module and fix any errors or warnings that come up.
55-
- Even better would be to set up `msftidy.rb` as a [pre-commit hook].
55+
- It would be even better to set up `msftidy.rb` as a [pre-commit hook].
5656
* **Do** use the many module mixin [API]s. Wheel improvements are welcome; wheel reinventions, not so much.
5757
* **Don't** include more than one module per pull request.
5858

@@ -80,19 +80,19 @@ Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow.
8080
* **Do** report vulnerabilities in Rapid7 software directly to [email protected].
8181
* **Do** write a detailed description of your bug and use a descriptive title.
8282
* **Do** include reproduction steps, stack traces, and anything else that might help us verify and fix your bug.
83-
* **Don't** file duplicate reports - search for your bug before filing a new report.
83+
* **Don't** file duplicate reports; search for your bug before filing a new report.
8484

8585
If you need some more guidance, talk to the main body of open
86-
source contributors over on the [Freenode IRC channel]
87-
or e-mail us at [metasploit-hackers] mailing list.
86+
source contributors over on the [Freenode IRC channel],
87+
or e-mail us at the [metasploit-hackers] mailing list.
8888

8989
Also, **thank you** for taking the few moments to read this far! You're
9090
already way ahead of the curve, so keep it up!
9191

9292
[Issue Tracker]:http://r-7.co/MSF-BUGv1
9393
[PGP key]:http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0x2380F85B8AD4DB8D
9494
[wiki]:https://github.com/rapid7/metasploit-framework/wiki
95-
[scripts]: https://github.com/rapid7/metasploit-framework/tree/master/scripts
95+
[scripts]:https://github.com/rapid7/metasploit-framework/tree/master/scripts
9696
[development environment setup]:http://r-7.co/MSF-DEV
9797
[Common Coding Mistakes]:https://github.com/rapid7/metasploit-framework/wiki/Common-Metasploit-Module-Coding-Mistakes
9898
[Ruby style guide]:https://github.com/bbatsov/ruby-style-guide
@@ -104,10 +104,10 @@ already way ahead of the curve, so keep it up!
104104
[PR#2940]:https://github.com/rapid7/metasploit-framework/pull/2940
105105
[PR#3043]:https://github.com/rapid7/metasploit-framework/pull/3043
106106
[pre-commit hook]:https://github.com/rapid7/metasploit-framework/blob/master/tools/dev/pre-commit-hook.rb
107-
[API]:https://rapid7.github.io/metasploit-framework/api/
108-
[RSpec]:http://rspec.info/
109-
[Better Specs]:http://betterspecs.org/
110-
[YARD]:http://yardoc.org/
107+
[API]:https://rapid7.github.io/metasploit-framework/api
108+
[RSpec]:http://rspec.info
109+
[Better Specs]:http://betterspecs.org
110+
[YARD]:http://yardoc.org
111111
[Issues]:https://github.com/rapid7/metasploit-framework/issues
112112
[Freenode IRC channel]:http://webchat.freenode.net/?channels=%23metasploit&uio=d4
113113
[metasploit-hackers]:https://lists.sourceforge.net/lists/listinfo/metasploit-hackers

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Metasploit [![Build Status](https://travis-ci.org/rapid7/metasploit-framework.pn
33
The Metasploit Framework is released under a BSD-style license. See
44
COPYING for more details.
55

6-
The latest version of this software is available from https://metasploit.com/
6+
The latest version of this software is available from: https://metasploit.com
77

88
Bug tracking and development information can be found at:
99
https://github.com/rapid7/metasploit-framework
@@ -20,8 +20,8 @@ Questions and suggestions can be sent to:
2020
Installing
2121
--
2222

23-
Generally, you should use [the free installer](https://www.metasploit.com/download)
24-
which contains all dependencies and will get you up and running with a
23+
Generally, you should use [the free installer](https://www.metasploit.com/download),
24+
which contains all of the dependencies and will get you up and running with a
2525
few clicks. See the [Dev Environment Setup](http://r-7.co/MSF-DEV) if
2626
you'd like to deal with dependencies on your own.
2727

@@ -34,10 +34,10 @@ resources](https://metasploit.github.io), or the [wiki].
3434

3535
Contributing
3636
--
37-
See the [Dev Environment Setup][wiki-devenv] guide on GitHub which will
38-
walk you through the whole process starting from installing all the
37+
See the [Dev Environment Setup][wiki-devenv] guide on GitHub, which will
38+
walk you through the whole process from installing all the
3939
dependencies, to cloning the repository, and finally to submitting a
40-
pull request. For slightly more info, see
40+
pull request. For slightly more information, see
4141
[Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).
4242

4343

msfvenom

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ require 'msf/core/payload_generator'
2828

2929
# Creates a new framework object.
3030
#
31-
# @note Ignores any previously cached value
31+
# @note Ignores any previously cached value.
3232
# @param (see ::Msf::Simple::Framework.create)
3333
# @return [Msf::Framework]
3434
def init_framework(create_opts={})
@@ -66,7 +66,7 @@ require 'msf/core/payload_generator'
6666
end
6767
end
6868

69-
opt.on('-l', '--list [module_type]', Array, 'List a module type example: payloads, encoders, nops, all') do |l|
69+
opt.on('-l', '--list [module_type]', Array, 'List a module type. Options are: payloads, encoders, nops, all') do |l|
7070
if l.nil? or l.empty?
7171
l = ["all"]
7272
end

0 commit comments

Comments
 (0)