[doc] Mention .document file in README
#1153
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
Rdoc has `.document` file in its root directory, allowing us to determine which files are the target for documentation. However, this fact is not mentioned anywhere in the doc including README, which makes it quite difficult to utilize this feature. This commit adds a mention to `.document` file in README so that users can find the feature more easily. One thing I'm not sure is if it's the right place. Currently README includes some usage information, which can be a separate file.
colby-swandale
approved these changes
Aug 12, 2024
st0012
reviewed
Aug 12, 2024
README.rdoc
Outdated
| @@ -60,6 +60,10 @@ To generate documentation programmatically: | |||
| rdoc.document options | |||
| # see RDoc::RDoc | |||
|
|
|||
| You can specify the target files for document generation with +.document+ file in the project root directory. | |||
| +.document+ file contains a list of file and directory names including comment lines starting with +#+. | |||
There was a problem hiding this comment.
Uh I didn't know + doesn't work with #, sorry 🤦♂️
Suggested change
| +.document+ file contains a list of file and directory names including comment lines starting with +#+. | |
| +.document+ file contains a list of file and directory names including comment lines starting with '#'. |
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.
Rdoc has
.documentfile in its root directory, allowing us to determine which files are the target for documentation. However, this fact is not mentioned anywhere in the doc including README, which makes it quite difficult to utilize this feature. This commit adds a mention to.documentfile in README so that users can find the feature more easily.One thing I'm not sure is if it's the right place. Currently README includes some usage information, which can be a separate file.