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.
https://github.com/ruby/rdoc/commit/e3688de49b
2023-09-05 00:45:42 +00:00
a14ba622da
[ruby/rdoc] handle symbols declared with `%s`
...
https://github.com/ruby/rdoc/commit/ed91c4b784
2023-09-05 00:37:30 +00:00
0c55ef1150
[ruby/rdoc] Use flat_map for better performance
...
https://github.com/ruby/rdoc/commit/76192a280d
2023-06-14 23:47:25 +00:00
a4d92475f6
[ruby/rdoc] Auto-correct trailing new lines
...
https://github.com/ruby/rdoc/commit/4b68c0728a
2023-06-03 01:42:29 +00:00
3833d0fee6
[ruby/rdoc] Fix references to nested label in table_of_contents
...
Fixes https://github.com/ruby/rdoc/pull/1000
https://github.com/ruby/rdoc/commit/291e2b7e8b
2023-05-02 04:19:46 +00:00
c2871161b4
[ruby/rdoc] Fix polynominal backtracking
...
Fix https://github.com/ruby/rdoc/pull/995
https://github.com/ruby/rdoc/commit/1311ca8c50
2023-04-29 16:55:37 +00:00
85a9fd1902
[ruby/rdoc] Fix polynominal backtracking
...
Fix https://github.com/ruby/rdoc/pull/995
https://github.com/ruby/rdoc/commit/adfa7db5b9
2023-04-29 16:55:36 +00:00
5116e8bdf8
[ruby/rdoc] Read generated files in binary mode
...
So that fixes crash with "invalid byte sequence in US-ASCII" on
ci.rvm.jp and some RubyCIs.
https://github.com/ruby/rdoc/commit/4b416644f0
2023-03-31 01:14:34 +00:00
773d56b1c1
[ruby/rdoc] Add test coverage for -C flag
...
https://github.com/ruby/rdoc/commit/564be08f4b
2023-02-06 23:09:06 +00:00
e04d20bc48
[ruby/rdoc] Add rdoc:coverage default task
...
https://github.com/ruby/rdoc/commit/157fbaf575
2023-02-03 23:41:06 +00:00
17b63ab6b1
[ruby/rdoc] Fix fragile tests
...
When the temporary path is long enough, the formatter may fold the
path and may hit a hyphen at the end of line, and miscounted.
https://github.com/ruby/rdoc/commit/5f46479543
2022-12-23 20:31:25 +09:00
9c1f03a38a
Debug for zlinux CI [ci skip]
2022-12-23 16:57:15 +09:00
792c50e917
[ruby/rdoc] Clean up home directories for each test
...
https://github.com/ruby/rdoc/commit/f067c174da
2022-12-23 11:05:09 +09:00
99cad3fccd
[ruby/rdoc] Non-RD part feature has not been imported to RDoc
...
https://github.com/ruby/rdoc/commit/fe0159de2f
2022-12-01 02:36:20 +09:00
e0901f46b7
[ruby/rdoc] Add `--no-skipping-tests` option
...
https://github.com/ruby/rdoc/commit/33925f885f
2022-11-28 04:36:29 +00:00
03b96319b4
Skip a broken RDoc test
...
http://ci.rvm.jp/results/trunk-yjit@phosphorus-docker/4309535
http://ci.rvm.jp/results/trunk-random0@phosphorus-docker/4309536
http://ci.rvm.jp/results/trunk-random1@phosphorus-docker/4309538
http://ci.rvm.jp/results/trunk-random2@phosphorus-docker/4309541
http://ci.rvm.jp/results/trunk-random3@phosphorus-docker/4309544
http://ci.rvm.jp/results/trunk-no-mjit@phosphorus-docker/4309550
http://ci.rvm.jp/results/trunk-yjit@phosphorus-docker/4309556
http://ci.rvm.jp/results/trunk-random0@phosphorus-docker/4309562
http://ci.rvm.jp/results/trunk-random1@phosphorus-docker/4309564
http://ci.rvm.jp/results/trunk-random2@phosphorus-docker/4309567
http://ci.rvm.jp/results/trunk-random3@phosphorus-docker/4309570
http://rubyci.s3.amazonaws.com/solaris10-gcc/ruby-master/log/20221127T200003Z.fail.html.gz
http://ci.rvm.jp/results/trunk-random-repeat@phosphorus-docker/4309581
http://rubyci.s3.amazonaws.com/freebsd12/ruby-master/log/20221127T203002Z.fail.html.gz
http://ci.rvm.jp/results/trunk-yjit@phosphorus-docker/4309588
2022-11-27 13:02:43 -08:00
5b1db79129
[ruby/rdoc] Revert "Refactor `RDoc::Markup::Parser#tokenize`"
...
This reverts commit https://github.com/ruby/rdoc/commit/41ceae93b3bc .
https://github.com/ruby/rdoc/commit/5d2c47e8b8
2022-11-27 19:46:12 +00:00
21977b95e2
[ruby/rdoc] Refactor `RDoc::Markup::Parser#tokenize`
...
Make verbatims text or newline only, and simplify `build_verbatim`.
https://github.com/ruby/rdoc/commit/41ceae93b3
2022-11-27 17:24:38 +00:00
ae3817bc61
[ruby/rdoc] Darkfish: Nest sidebar ToC as a tree of headings
...
This uses `<details><summary>heading</summary><ul>nested</ul></detail>`,
similar to how the classes and pages lists are now nested.
https://github.com/ruby/rdoc/commit/e57beff287
2022-11-27 17:18:16 +00:00
a87de5e3c1
[ruby/rdoc] Special characters are prohibited as filename on Windows
...
https://github.com/ruby/rdoc/commit/13b9da5932
2022-10-07 12:12:10 +09:00
a3cb09c7d1
[ruby/rdoc] Escape file names
...
https://hackerone.com/reports/1321358
https://github.com/ruby/rdoc/commit/8c07cc4657
2022-10-07 12:12:08 +09:00
8d0b2162a0
[ruby/rdoc] Escape main title
...
https://hackerone.com/reports/1187156
https://github.com/ruby/rdoc/commit/5dedb5741d
2022-10-07 12:09:23 +09:00
586e18b946
[ruby/rdoc] Escape HYPERLINKs
...
https://github.com/ruby/rdoc/commit/ac35485be6
2022-10-07 12:09:22 +09:00
9e3ab9da7f
[ruby/rdoc] Escape RDOCLINKs
...
https://hackerone.com/reports/1187156
https://github.com/ruby/rdoc/commit/7cecf1efae
2022-10-07 12:09:21 +09:00
deaa656608
[ruby/rdoc] Escape TIDYLINKs
...
https://hackerone.com/reports/1187156
https://github.com/ruby/rdoc/commit/1ad2dd3ca2
2022-10-07 12:09:20 +09:00
cf3056be69
[ruby/rdoc] Add center align
...
https://github.com/ruby/rdoc/commit/512cc55a0e
2022-10-06 23:22:02 +09:00
28e24ce355
[ruby/rdoc] Allow spaces around pipes
...
https://github.com/ruby/rdoc/commit/3b3a583580
2022-10-06 23:21:16 +09:00
7c03c82444
[ruby/rdoc] Allow escaped pipes in cells
...
https://github.com/ruby/rdoc/commit/333952a62d
2022-10-06 23:17:49 +09:00
f6c916c7ef
[ruby/rdoc] Allow leading pipes to be ommitted
...
https://github.com/ruby/rdoc/commit/d263a2c9c4
2022-10-06 23:16:54 +09:00
a19bf47d03
[ruby/rdoc] Allow trailing pipes to be ommitted
...
https://github.com/ruby/rdoc/commit/1318048877
2022-10-06 23:14:29 +09:00
75a53f6be0
[ruby/rdoc] Allow RDoc markups in table cells
...
https://github.com/ruby/rdoc/commit/b16d3f1727
2022-10-06 18:24:44 +09:00
e929b0aac5
[ruby/rdoc] Add `RDoc::Markup::ToHtml#accept_table` test
...
https://github.com/ruby/rdoc/commit/0cb3df713b
2022-10-06 18:24:43 +09:00
d89f8a0467
[ruby/rdoc] Fix ruby script in "test_parse_method_bracket" ( https://github.com/ruby/rdoc/pull/927 )
...
Because it's syntax error.
https://github.com/ruby/rdoc/commit/993f2532ff
2022-09-26 09:38:40 +09:00
5beb75ce8d
[ruby/rdoc] Allow multiple footnotes without in-between blank lines
...
https://github.com/ruby/ruby/commit/e4e054e3ce40 used four footnotes
without blank lines. And the ChangeLog generated from that commit
resulted in ``undefined method `parts' for nil`` error.
For now, let a footnote terminated by the next footnote mark.
Also refined the error message when undefined footnote is used.
https://github.com/ruby/rdoc/commit/a7f290130b
2022-08-08 01:12:49 +09:00
af265d73fb
[ruby/rdoc] Fix blockquote with word in verbatim
...
https://github.com/ruby/rdoc/commit/75eee668a5
2022-07-30 11:04:11 +09:00
f29f1d22c3
[ruby/rdoc] Fix formatting blockquote in verbatim
...
Reported at https://github.com/ruby/rdoc/pull/907#discussion_r932505816
https://github.com/ruby/rdoc/commit/86384ac7f9
2022-07-29 09:21:33 +09:00
dd362a786a
[ruby/rdoc] Fix call-seq for aliased method with similar names
...
deduplicate_call_seq has a bug that skips call-seq for methods where the
alias is a prefix of the method name. For example, if the alias name is
"each" and the current method name is "each_line", then
deduplicate_call_seq will skip all call-seq for "each_line" since it
will believe that it is for the alias.
https://github.com/ruby/rdoc/commit/1148988ccc
2022-07-18 22:36:57 +09:00
da21a2c388
[ruby/rdoc] `RubyVM` is implementation dependent
...
https://github.com/ruby/rdoc/commit/aaeb5ce1ce
2022-07-11 13:43:15 +09:00
b564ef3698
[ruby/rdoc] Fix the known classes more
...
https://github.com/ruby/rdoc/commit/9f47234e0e
2022-07-11 13:43:14 +09:00
86df6f4bb3
[ruby/rdoc] Fix an exception class name
...
https://github.com/ruby/rdoc/commit/87301da71b
2022-07-11 13:14:06 +09:00
131422ceea
[ruby/rdoc] Support attributes defined by `rb_struct_define`
...
https://github.com/ruby/rdoc/commit/854b370763
2022-06-28 20:17:30 +09:00
51be2cf6d2
[ruby/rdoc] Parse also InitVM-prefixed functions
...
Initialization depending on VM is separated.
https://github.com/ruby/rdoc/commit/030d10fccd
2022-06-28 14:51:49 +09:00
dbfb3b1917
[ruby/rdoc] Allow boolean arguments to `rb_attr` and `rb_define_attr`
...
Currently only literal `0` and `1` are accepted as `read`/`write`
flags.
This patch allows other boolean arguments, C macros (`FALSE`/`TRUE`),
Ruby `VALUE`s (`Qfalse`/`Qtrue`), and C99 `bool`s (`false`/`true`), as
well.
https://github.com/ruby/rdoc/commit/169dc02e3c
2022-06-07 10:42:10 +09:00
66a9e452bb
[ruby/rdoc] Use runnable command as DUMMY_PAGER
...
https://github.com/ruby/rdoc/commit/fec1ab2e41
2022-06-06 21:19:45 +09:00
9a7be959b1
[ruby/rdoc] Remove `RDoc::RI::Driver#in_path?`
...
https://github.com/ruby/rdoc/commit/83051403d6
2022-06-04 16:42:10 +09:00
d4c7e4d5bb
[ruby/rdoc] Enable pager tests
...
https://github.com/ruby/rdoc/commit/ce63794fde
2022-06-04 16:42:09 +09:00
5397dd2e76
[ruby/rdoc] Apply matching word pairs to underscore-methods
...
Protected characters with `PROTECT_ATTR` should not have special
roles.
https://github.com/ruby/rdoc/commit/c318af0ea2
2022-04-14 16:37:14 +09:00
e06100d969
[ruby/rdoc] Allow cross references to methods including underscores
...
As underscores are masked to "protect" from the conversion, consider
also `PROTECT_ATTR` as a word character.
https://github.com/ruby/rdoc/commit/db58bb5170
2022-04-14 12:51:30 +09:00
aaac279de0
[ruby/rdoc] Only parse valid URLs
...
Only valid characters for URLs should be used for generating URLs.
A list of valid characters can be found in sections 2.2 and 2.3 of IETF
RFC 3986 (https://www.ietf.org/rfc/rfc3986.txt ).
https://github.com/ruby/rdoc/commit/2bd8fcdd4f
2022-04-13 22:25:33 +09:00
92ef73a918
[ruby/rdoc] Expand the enclosing tree of the current file
...
https://github.com/ruby/rdoc/commit/f9f90ef2ff
2022-03-22 01:32:13 +09:00
Jeremy Evans
theo-squadracer
Petrik
Vinicius Stock
Nobuyoshi Nakada
zzak
Sven Riedel
Takashi Kokubun
nick evans
Yuichiro Kaneko
Peter Zhu