Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new tidy_docs checks #13188

Merged
merged 2 commits into from
Apr 6, 2020
Merged

new tidy_docs checks #13188

merged 2 commits into from
Apr 6, 2020

Conversation

h00die
Copy link
Contributor

@h00die h00die commented Apr 2, 2020

New enforcements for msftidy_docs.rb

  1. All options should be H3 (###) instead of bold (**). This is a change from our previous standard. @tperry-r7 asked for this
  2. Some options aren't needed because they're universal. Every docs doesn't need to say rhosts, so we'll ask to not have the following (maybe more?) rhost|rhosts|rport|lport|lhost|srvhost|srvport|ssl|uripath|session|proxies|payload

Assigning to @tperry-r7 who is the one who recommended these changes.

@h00die
Copy link
Contributor Author

h00die commented Apr 3, 2020

@ccondon-r7

@tperry-r7
Copy link
Contributor

@h00die Would it be easier to leave it as bold instead? I'm pretty open to whatever is easiest.

@h00die
Copy link
Contributor Author

h00die commented Apr 6, 2020

That's your call as an r7 employee :)

@tperry-r7
Copy link
Contributor

tperry-r7 commented Apr 6, 2020

@h00die Let's do this going forward, but not make it a big project for old module docs.

@tperry-r7 tperry-r7 merged commit 62dd03c into rapid7:master Apr 6, 2020
@h00die h00die deleted the tidy_options_h3 branch April 7, 2020 14:39
@wvu
Copy link
Contributor

wvu commented Apr 8, 2020

Release Notes

This adds additional checks to the tools/dev/msftidy_docs.rb module documentation linter.

@tperry-r7 tperry-r7 added the rn-enhancement release notes enhancement label Apr 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy enhancement rn-enhancement release notes enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants