Skip to content

Fix C extension docs in ruby/ruby #3927

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

Merged
kddnewton merged 1 commit into from
Feb 16, 2026
+20 −3
Merged

Fix C extension docs in ruby/ruby #3927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions ext/prism/extension.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,7 @@ dump_input(pm_string_t *input, const pm_options_t *options) {
}

/**
* :markup: markdown
* call-seq:
* dump(source, **options) -> String
*
Expand Down Expand Up @@ -422,6 +423,7 @@ dump(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* dump_file(filepath, **options) -> String
*
Expand Down Expand Up @@ -794,6 +796,7 @@ parse_lex_input(pm_string_t *input, const pm_options_t *options, bool return_nod
}

/**
* :markup: markdown
* call-seq:
* lex(source, **options) -> LexResult
*
Expand All @@ -814,6 +817,7 @@ lex(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* lex_file(filepath, **options) -> LexResult
*
Expand Down Expand Up @@ -865,6 +869,7 @@ parse_input(pm_string_t *input, const pm_options_t *options) {
}

/**
* :markup: markdown
* call-seq:
* parse(source, **options) -> ParseResult
*
Expand Down Expand Up @@ -933,6 +938,7 @@ parse(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* parse_file(filepath, **options) -> ParseResult
*
Expand Down Expand Up @@ -968,6 +974,7 @@ profile_input(pm_string_t *input, const pm_options_t *options) {
}

/**
* :markup: markdown
* call-seq:
* profile(source, **options) -> nil
*
Expand All @@ -989,6 +996,7 @@ profile(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* profile_file(filepath, **options) -> nil
*
Expand Down Expand Up @@ -1041,6 +1049,7 @@ parse_stream_fgets(char *string, int size, void *stream) {
}

/**
* :markup: markdown
* call-seq:
* parse_stream(stream, **options) -> ParseResult
*
Expand Down Expand Up @@ -1094,6 +1103,7 @@ parse_input_comments(pm_string_t *input, const pm_options_t *options) {
}

/**
* :markup: markdown
* call-seq:
* parse_comments(source, **options) -> Array
*
Expand All @@ -1114,6 +1124,7 @@ parse_comments(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* parse_file_comments(filepath, **options) -> Array
*
Expand All @@ -1136,6 +1147,7 @@ parse_file_comments(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* parse_lex(source, **options) -> ParseLexResult
*
Expand Down Expand Up @@ -1163,6 +1175,7 @@ parse_lex(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* parse_lex_file(filepath, **options) -> ParseLexResult
*
Expand Down Expand Up @@ -1209,6 +1222,7 @@ parse_input_success_p(pm_string_t *input, const pm_options_t *options) {
}

/**
* :markup: markdown
* call-seq:
* parse_success?(source, **options) -> bool
*
Expand All @@ -1229,6 +1243,7 @@ parse_success_p(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* parse_failure?(source, **options) -> bool
*
Expand All @@ -1241,6 +1256,7 @@ parse_failure_p(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* parse_file_success?(filepath, **options) -> bool
*
Expand All @@ -1263,6 +1279,7 @@ parse_file_success_p(int argc, VALUE *argv, VALUE self) {
}

/**
* :markup: markdown
* call-seq:
* parse_file_failure?(filepath, **options) -> bool
*
Expand Down Expand Up @@ -1297,6 +1314,7 @@ string_query(pm_string_query_t result) {
}

/**
* :markup: markdown
* call-seq:
* local?(string) -> bool
*
Expand All @@ -1311,6 +1329,7 @@ string_query_local_p(VALUE self, VALUE string) {
}

/**
* :markup: markdown
* call-seq:
* constant?(string) -> bool
*
Expand All @@ -1325,6 +1344,7 @@ string_query_constant_p(VALUE self, VALUE string) {
}

/**
* :markup: markdown
* call-seq:
* method_name?(string) -> bool
*
Expand Down
1 change: 0 additions & 1 deletion rakelib/rdoc.rake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ end

RDoc::Task.new(:rdoc) do |rdoc|
rdoc.main = "README.md"
rdoc.markup = "markdown"

rdoc.rdoc_dir = "doc/rb"
rdoc.options.push("--all", "-x", "lib/prism/translation/ripper/shim.rb")
Expand Down
2 changes: 0 additions & 2 deletions templates/template.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,8 +660,6 @@ def render(name, write_to: nil)
HEADING
else
<<~HEADING
/* :markup: markdown */

/*----------------------------------------------------------------------------*/
/* This file is generated by the templates/template.rb script and should not */
/* be modified manually. See */
Expand Down