Граф коммитов

5 Коммитов

Автор SHA1 Сообщение Дата
Burdette Lamar c129b6119d
[DOC] Use RDoc inclusions in string.c (#5683)
As @peterzhu2118 and @duerst have pointed out, putting string method's RDoc into doc/ (which allows non-ASCII in examples) makes the "click to toggle source" feature not work for that method.

This PR moves the primary method doc back into string.c, then includes RDoc from doc/string/*.rdoc, and also removes doc/string.rdoc.

The affected methods are:

    ::new
    #bytes
    #each_byte
    #each_line
    #split

The call-seq is in string.c because it works there; it did not work when the call-seq is in doc/string/*.rdoc.

This PR also updates the relevant guidance in doc/documentation_guide.rdoc.
2022-03-21 14:58:00 -05:00
Nobuyoshi Nakada b426de9e8e
[DOC] Prefer local rdoc links
- ensures exact same version
- avoid generated URLs
- no external access
- concise
2022-03-16 19:12:34 +09:00
Burdette Lamar 09186f381f
Adding guidance about characters in C-code doc (#5641)
Showing how to do as @nobu does -- putting doc into doc/*.rdoc instead of in *.c.
2022-03-11 10:46:47 -06:00
Burdette Lamar 1dd2d2ce48
[DOC] Change to guidance on lists in What's Here section (#5618)
Currently, the guide says a "What's Here" section should have a labeled list for the methods. Such a list can render very differently in different browsers, and are often erratic in their indentation of continuation lines.
2022-03-07 05:04:16 -06:00
Burdette Lamar a541fe1a75
Doc guide for class/module (#4600)
Co-authored-by: Marivaldo Cavalheiro <marivaldo@gmail.com>
2021-07-18 18:43:34 -04:00