archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-25 14:05:02 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
ruby/test/rdoc
History
Jeremy Evans 3f6c92e9d5 [ruby/rdoc] Omit descriptions and parameter lists for methods defined in C not mentioned in call-seq 
This allows RDoc to better generate documentation for methods
following the Ruby core documentation guide (which omits aliases
in call-seq in most cases).  This makes documentation for methods
defined in C more similar to methods defined in Ruby.  For methods
defined in Ruby, the method description of the aliased method is
already not used (you have to explicitly document the alias to
use it).

Internally, this adds AnyMethod#has_call_seq? and #skip_description?,
and updates Darkfish to:

* only show the method name if there is a call-seq for the method,
  but the call-seq omits the method
* to omit the method description if the method is an alias or has
  aliases and has a call-seq that does not include the method

See discussion in https://github.com/ruby/ruby/pull/7316 for
details.

e3688de49b
2023-09-05 00:45:42 +00:00
..
MarkdownTest_1.0.3
support [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
binary.dat
helper.rb
hidden.zip.txt
README
test.ja.largedoc
test.ja.rdoc
test.ja.txt
test.txt
test_rdoc_alias.rb
test_rdoc_any_method.rb [ruby/rdoc] Omit descriptions and parameter lists for methods defined in C not mentioned in call-seq 2023-09-05 00:45:42 +00:00
test_rdoc_attr.rb
test_rdoc_class_module.rb
test_rdoc_code_object.rb
test_rdoc_comment.rb [ruby/rdoc] Fix polynominal backtracking 2023-04-29 16:55:37 +00:00
test_rdoc_constant.rb
test_rdoc_context.rb
test_rdoc_context_section.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_cross_reference.rb
test_rdoc_encoding.rb
test_rdoc_extend.rb
test_rdoc_generator_darkfish.rb [ruby/rdoc] Fix references to nested label in table_of_contents 2023-05-02 04:19:46 +00:00
test_rdoc_generator_json_index.rb
test_rdoc_generator_markup.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_generator_pot.rb
test_rdoc_generator_pot_po.rb
test_rdoc_generator_pot_po_entry.rb
test_rdoc_generator_ri.rb
test_rdoc_i18n_locale.rb
test_rdoc_i18n_text.rb
test_rdoc_include.rb
test_rdoc_markdown.rb [ruby/rdoc] Add center align 2022-10-06 23:22:02 +09:00
test_rdoc_markdown_test.rb
test_rdoc_markup.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_attribute_manager.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_attributes.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_document.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_formatter.rb
test_rdoc_markup_hard_break.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_heading.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_include.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_indented_paragraph.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_paragraph.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_parser.rb [ruby/rdoc] Revert "Refactor RDoc::Markup::Parser#tokenize" 2022-11-27 19:46:12 +00:00
test_rdoc_markup_pre_process.rb
test_rdoc_markup_raw.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_to_ansi.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_to_bs.rb
test_rdoc_markup_to_html.rb [ruby/rdoc] Use flat_map for better performance 2023-06-14 23:47:25 +00:00
test_rdoc_markup_to_html_crossref.rb
test_rdoc_markup_to_html_snippet.rb
test_rdoc_markup_to_joined_paragraph.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_to_label.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_to_markdown.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_to_rdoc.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_to_table_of_contents.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_to_tt_only.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_markup_verbatim.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_method_attr.rb
test_rdoc_normal_class.rb
test_rdoc_normal_module.rb
test_rdoc_options.rb [ruby/rdoc] Add test coverage for -C flag 2023-02-06 23:09:06 +00:00
test_rdoc_parser.rb
test_rdoc_parser_c.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_parser_changelog.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_parser_markdown.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_parser_rd.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_parser_ruby.rb [ruby/rdoc] handle symbols declared with %s 2023-09-05 00:37:30 +00:00
test_rdoc_parser_simple.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_rd.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_rd_block_parser.rb [ruby/rdoc] Non-RD part feature has not been imported to RDoc 2022-12-01 02:36:20 +09:00
test_rdoc_rd_inline.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_rd_inline_parser.rb
test_rdoc_rdoc.rb [ruby/rdoc] Add --no-skipping-tests option 2022-11-28 04:36:29 +00:00
test_rdoc_require.rb
test_rdoc_ri_driver.rb [ruby/rdoc] Fix fragile tests 2022-12-23 20:31:25 +09:00
test_rdoc_ri_paths.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_rubygems_hook.rb
test_rdoc_servlet.rb
test_rdoc_single_class.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_stats.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_store.rb [ruby/rdoc] Use flat_map for better performance 2023-06-14 23:47:25 +00:00
test_rdoc_task.rb [ruby/rdoc] Add rdoc:coverage default task 2023-02-03 23:41:06 +00:00
test_rdoc_text.rb
test_rdoc_token_stream.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
test_rdoc_tom_doc.rb
test_rdoc_top_level.rb
xref_data.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00
xref_test_case.rb [ruby/rdoc] Auto-correct trailing new lines 2023-06-03 01:42:29 +00:00

README 

you don't have to