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

Add .yardoc to generated plugin .gitignore #38909

Closed

Conversation

jonathanhefner
Copy link
Member

Although Rails uses RDoc, Yard is also a popular choice. If the Yard gem is installed, the yard doc command will generate documentation for a plugin without the need for a Rake task or other configuration. Doing so generates doc/ and .yardoc/ directories. The former is already in the generated .gitignore file. This commit adds the latter.

Although Rails uses RDoc, Yard is also a popular choice.  If the Yard
gem is installed, the `yard doc` command will generate documentation for
a plugin without the need for a Rake task or other configuration.  Doing
so generates doc/ and .yardoc/ directories.  The former is already in
the generated .gitignore file.  This commit adds the latter.
@rails-bot rails-bot bot added the railties label Apr 9, 2020
@rafaelfranca
Copy link
Member

Thank you for the pull request but I don't think Rails should deal with project specific choices.

@jonathanhefner
Copy link
Member Author

@rafaelfranca Because the yard command can also parse and generate documentation for RDoc comments, I think of it more as a developer choice than a project choice. (As an example, here is documentation for Array#to_sentence generated by yard.)

@rafaelfranca
Copy link
Member

It is a project choice in the sense that you need to chose to install yard and run it. Yes, it is true that it works out-of-the-box, but it is also true that Rails doesn't install it, neither Ruby. If you are choosing to install and run yard, you also add it to your .gitignore.

@rafaelfranca
Copy link
Member

If it is a developer choice it is even easier, it should be in the developers global gitignore, like the editor specific files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants