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

Move doc/markup_reference.rb to doc/rdoc #899

Merged
merged 2 commits into from Jul 25, 2022
Merged

Move doc/markup_reference.rb to doc/rdoc #899

merged 2 commits into from Jul 25, 2022

Conversation

BurdetteLamar
Copy link
Member

No description provided.

Copy link
Member

@peterzhu2118 peterzhu2118 left a comment

Choose a reason for hiding this comment

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

I'm not sure what problem this is supposed to solve. It just includes the file doc/markup_reference.rb in the built .gem file that is built, but markup_reference.rb is just documentation, so I don't see why it's included in the built gem.

@BurdetteLamar
Copy link
Member Author

See https://ruby.slack.com/archives/C02A3SL0S/p1658264615750489. I think this PR solves the problem.

@peterzhu2118
Copy link
Member

I don't see how this PR solves the problem. docs.ruby-lang.org is built from the ruby/ruby repository. I don't think this will sync the doc/markup_reference.rb file to the ruby/ruby repository.

@BurdetteLamar
Copy link
Member Author

Somehow, doc/ files from ruby/csv get into ruby/ruby, but doc/ files from ruby/rdoc don't. If this is not the way, do you know how to make that happen?

@peterzhu2118
Copy link
Member

From what I can tell, it looks manually sync'd, not automatically. Looks like that tool to do the sync is in tool/sync_default_gems.rb and you can run it using tool/sync_default_gems.rb -a rdoc.

@BurdetteLamar
Copy link
Member Author

So I would add to the clause when "rdoc" in that program?
`

@peterzhu2118
Copy link
Member

It would be a good idea to move all the files in the doc directory of RDoc to doc/rdoc to prevent name collisions. Then you can add something like:

cp_r("#{upstream}/doc/rdoc", "doc")

@BurdetteLamar
Copy link
Member Author

It would be a good idea to move all the files in the doc directory of RDoc to doc/rdoc to prevent name collisions. Then you can add something like:

cp_r("#{upstream}/doc/rdoc", "doc")

Done.

Copy link
Member

@peterzhu2118 peterzhu2118 left a comment

Choose a reason for hiding this comment

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

Can you change the PR title to match the changes? Otherwise it looks good.

@BurdetteLamar BurdetteLamar changed the title Add markup_reference.rb to gemspec Move doc/markup_reference.rb to doc/rdoc Jul 25, 2022
@BurdetteLamar BurdetteLamar merged commit 52b861e into ruby:master Jul 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants