Update Writing Module Docs to reference msftidy_docs.rb #18452
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
jheysel-r7
commented
Oct 13, 2023
adfoster-r7
added
the
rn-documentation
Release NotesUpdates the Metasploit Wiki to include information on how to run quality tools on module documentation |
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.
msftidy_docs.rb is referenced under the Checking Documentation Syntax in the Creating Your First PR page. However it seems like it should probably be mentioned in Writing-Module-Documentation.md as well. Especially as #12389 directs users there via this helpful comment: #12389 (comment)