Skip to content

Conversation

okuramasafumi
Copy link
Contributor

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.

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.
Copy link
Member

@st0012 st0012 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

README.rdoc Outdated
# 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 +#+.
Copy link
Member

@st0012 st0012 Aug 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 '#'.

@st0012 st0012 merged commit d711a2c into ruby:master Aug 12, 2024
@okuramasafumi okuramasafumi deleted the mention-dot-document-in-readme branch August 12, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants