Skip to content

RDoc markdown mode#3572

Merged
kddnewton merged 6 commits intoruby:mainfrom
nobu:rdoc-markdown
May 29, 2025
Merged

RDoc markdown mode#3572
kddnewton merged 6 commits intoruby:mainfrom
nobu:rdoc-markdown

Conversation

@nobu
Copy link
Member

@nobu nobu commented May 28, 2025

The documents in Prism look like markdown, not RDoc format.

@nobu nobu added the documentation Improvements or additions to documentation label May 28, 2025
@nobu nobu force-pushed the rdoc-markdown branch from bd14f7d to 1cae6e3 Compare May 28, 2025 21:12
@kddnewton kddnewton merged commit 41332e7 into ruby:main May 29, 2025
57 checks passed
@nobu nobu deleted the rdoc-markdown branch June 17, 2025 10:18
Earlopain added a commit to Earlopain/prism that referenced this pull request Feb 16, 2026
Because ruby/ruby doesn't use our rake task it also uses the default markup (rdoc), unless specified otherwise.
github.com/ruby/pull/3572 already added it explicitly to ruby files.

For C however, it is not so easy because of a rdoc bug: ruby/rdoc#1597
Adding the comment would remove all documentation since it gets parsed as ruby.

So, specify it for each method individually. Remove it from the template since there is only one C file relevant for rdoc.
kddnewton pushed a commit that referenced this pull request Feb 16, 2026
Because ruby/ruby doesn't use our rake task it also uses the default markup (rdoc), unless specified otherwise.
github.com//pull/3572 already added it explicitly to ruby files.

For C however, it is not so easy because of a rdoc bug: ruby/rdoc#1597
Adding the comment would remove all documentation since it gets parsed as ruby.

So, specify it for each method individually. Remove it from the template since there is only one C file relevant for rdoc.
matzbot pushed a commit to ruby/ruby that referenced this pull request Feb 16, 2026
Because ruby/ruby doesn't use our rake task it also uses the default markup (rdoc), unless specified otherwise.
github.com/ruby/prism/pull/3572 already added it explicitly to ruby files.

For C however, it is not so easy because of a rdoc bug: ruby/rdoc#1597
Adding the comment would remove all documentation since it gets parsed as ruby.

So, specify it for each method individually. Remove it from the template since there is only one C file relevant for rdoc.

ruby/prism@4ee9b1b651
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants