Skip to content

Do not generate yard documentation when building in TruffleRuby #659

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 10, 2023
Merged

Do not generate yard documentation when building in TruffleRuby #659

merged 1 commit into from
Mar 10, 2023

Conversation

jcouball
Copy link
Member

Your checklist for this pull request

🚨Please review the guidelines for contributing to this repository.

  • Ensure all commits include DCO sign-off.
  • Ensure that your contributions pass unit testing.
  • Ensure that your contributions contain documentation if applicable.

Description

When building YARD documentation using TruffleRuby-head, the following error occurs which fails the build:

[warn]: Syntax error in `lib/git/lib.rb`:(695,11): _1 is reserved for numbered parameter
[20](https://github.com/ruby-git/ruby-git/actions/runs/4380304214/jobs/7667220593#step:4:21)
[warn]: ParserSyntaxError: syntax error in `lib/git/lib.rb`:(695,11): _1 is reserved for numbered parameter
[21](https://github.com/ruby-git/ruby-git/actions/runs/4380304214/jobs/7667220593#step:4:22)
[warn]: Stack trace:
[22](https://github.com/ruby-git/ruby-git/actions/runs/4380304214/jobs/7667220593#step:4:23)
	/home/runner/work/ruby-git/ruby-git/vendor/bundle/truffleruby/3.1.3.3/gems/yard-0.9.28/lib/yard/parser/ruby/ruby_parser.rb:601:in `on_parse_error'
[23](https://github.com/ruby-git/ruby-git/actions/runs/4380304214/jobs/7667220593#step:4:24)
	/home/runner/.rubies/truffleruby-head/lib/truffle/truffle/cext.rb:919:in `rb_funcall'
[24](https://github.com/ruby-git/ruby-git/actions/runs/4380304214/jobs/7667220593#step:4:25)
	ripper.y:13755:in `ripper_compile_error'
[25](https://github.com/ruby-git/ruby-git/actions/runs/4380304214/jobs/7667220593#step:4:26)
	ripper.y:12686:in `numparam_name'
[26](https://github.com/ruby-git/ruby-git/actions/runs/4380304214/jobs/7667220593#step:4:27)
	ripper.y:1808:in `ripper_yyparse'
[27](https://github.com/ruby-git/ruby-git/actions/runs/4380304214/jobs/7667220593#step:4:28)
	ripper.y:13844:in `ripper_parse0'
[28](https://github.com/ruby-git/ruby-git/actions/runs/4380304214/jobs/7667220593#step:4:29)

For this project, YARD docs do not need to be built using TruffleRuby so I am disabling this for now.

@jcouball
Do not generate yard documentation when building in TruffleRuby
8faf94a 
Signed-off-by: James Couball <jcouball@yahoo.com>
@jcouball jcouball added the internal-change The PR includes changes that are NOT user facing and will NOT require a release label Mar 10, 2023
@jcouball jcouball merged commit b53d308 into master Mar 10, 2023
@jcouball jcouball mentioned this pull request Mar 19, 2023
Merged
@jcouball jcouball deleted the no_yard_for_truffleruby branch April 1, 2023 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
internal-change The PR includes changes that are NOT user facing and will NOT require a release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jcouball