sampatbadhe
1fe2e34613
Fix a typo Denail-of-Service => Denial-of-Service [ci skip]
2022-10-08 12:36:05 +09:00
Burdette Lamar
7837dccb0e
Adapt doc guide to new GFM features ( #6504 )
...
* Adapt doc guide to new GFM features
* Adapt doc guide to new GFM features
2022-10-06 15:02:37 -05:00
Burdette Lamar
5fc68e1101
[DOC] Adding remarks about HTML and tables ( #6485 )
...
* Adding remarks about HTML and tables
2022-10-04 13:50:33 -05:00
Burdette Lamar
5d4048e0bc
[DOC] More on IO streams ( #6454 )
...
Adds remarks about .new and .open.
Uses ..open where convenient (not convenient where output would be in a block).
Fixed examples for #ungetc.
2022-09-27 13:58:28 -05:00
Burdette Lamar
c35e924f64
[DOC] More on IO streams ( #6445 )
...
Text is reorganized so that most of the previous text is now in these newly-created sections:
Basic IO
Line IO
New text is added to form new sections:
Character IO
Byte IO
Codepoint IO
This gives the page a functional orientation, so that a reader can quickly find pertinent sections.
The page retains its original mission: to provide good link targets for the doc for related classes.
2022-09-27 08:50:53 -05:00
Burdette Lamar
3ddab3a84e
[DOC] Housekeeping in iostreams doc ( #6420 )
...
Write some method names in linkable form; make some capitalization consistent.
2022-09-23 09:41:21 -05:00
Burdette Lamar
56d773dc6f
New page IO Streams ( #6383 )
...
This page provides an overview of IO streams. It's meant to be linked to from many other doc spots. In particular it will be linked to from many places in ARGF, File, IO, and StringIO.
2022-09-21 16:34:55 -05:00
Akihiro Sada
02e25db68f
Add URI.escape and URI.unescape to NEWS-3.0.0 [ci skip]
2022-09-21 17:35:22 +09:00
Takashi Kokubun
7cab7e5fde
Stop recommending duplicated options [ci skip] ( #6400 )
2022-09-19 15:13:53 +09:00
Nobuyoshi Nakada
a8a7c9d05d
[DOC] [Bug #17120 ] Fix match-reset `\K`
2022-09-05 19:36:21 +09:00
Takashi Kokubun
915cbdb226
Stop testing MJIT on s390x
...
It didn't work either.
http://rubyci.s3.amazonaws.com/s390x/ruby-master/log/20220905T080003Z.fail.html.gz
2022-09-05 02:02:17 -07:00
Takashi Kokubun
fb769aaa14
Update MJIT doc about bindgen and platforms [ci skip]
2022-09-05 01:30:50 -07:00
Nobuyoshi Nakada
0111dc5b79
[DOC] Escape backqoute method not to be converted to smart quotes
2022-09-03 23:47:46 +09:00
Takashi Kokubun
ce70cb6469
It was a relative path [ci skip]
2022-08-31 17:18:22 -07:00
Takashi Kokubun
a0d2320f30
Add a document about YJIT's Rust version
2022-08-31 17:16:29 -07:00
Burdette Lamar
d41be1ac37
[DOC] Enhanced RDoc for Time ( #6308 )
...
More on timezones.
2022-08-31 16:36:22 -05:00
Takashi Kokubun
221a523683
Put a documentation about MJIT [ci skip]
2022-08-30 17:07:27 -07:00
Maxime Chevalier-Boisvert
5ef048e5b1
Update yjit.md
...
Add VMIL paper, update supported CPUs.
2022-08-29 09:09:41 -07:00
Burdette Lamar
8706b74b90
[DOC] Enhanced RDoc for Time ( #6277 )
...
Deletes the :include: files in doc/time, which became no longer workable when @nobu pointed out that some (but not all) creator methods accept string values as well as integer-like values.
Changes to methods:
Time.utc
Time.local
Time.at
Time.new
2022-08-25 13:02:18 -05:00
Burdette Lamar
aeac8b6c3a
[DOC] Addition to section 'Related Methods' ( #6271 )
...
Addition to section 'Related Methods': suggests adding differentiators to the names of related methods.
2022-08-22 13:17:05 -05:00
Burdette Lamar
b8d142e733
[DOC] Enhanced RDoc for Time ( #6267 )
...
Treats:
#utc
#getlocal
#getutc
#ctime
#to_s
#inspect
2022-08-22 11:21:36 -05:00
Nobuyoshi Nakada
148d0ccd18
[DOC] Fix a type [ci skip]
2022-08-22 23:15:30 +09:00
Nobuyoshi Nakada
f99904341e
[DOC] Remove extra page-dir prefix
2022-08-22 23:15:30 +09:00
Burdette Lamar
936327a519
[DOC] Enhanced RDoc for Time ( #6255 )
...
Treats:
#utc
#hash
#localtime
2022-08-21 11:36:36 -05:00
Nobuyoshi Nakada
bd0fe26b81
[DOC] Fix "military timezone"
...
Not only `J` is called military timezone.
2022-08-19 10:20:52 +09:00
Peter Zhu
4e66b3f47b
[ruby/rdoc] [DOC] Remove duplicated line in RDoc::MarkupReference
...
https://github.com/ruby/rdoc/commit/488f89aee4
2022-08-16 02:48:04 +09:00
Burdette Lamar
fa65800ee5
[ruby/rdoc] [DOC] Enhances text about escapes ( https://github.com/ruby/rdoc/pull/917 )
...
https://github.com/ruby/rdoc/commit/c40bac829c
2022-08-13 09:00:18 +09:00
Burdette Lamar
5e3e4bc984
[ruby/rdoc] Mods to section Text Markup ( https://github.com/ruby/rdoc/pull/916 )
...
https://github.com/ruby/rdoc/commit/5506d4d67e
2022-08-12 05:09:02 +09:00
Burdette Lamar
8a3f401b24
[ruby/rdoc] Improvements to Text Markup examples ( https://github.com/ruby/rdoc/pull/915 )
...
https://github.com/ruby/rdoc/commit/d00ddfe57c
2022-08-12 01:43:43 +09:00
Burdette Lamar
c361cf44c0
[ruby/rdoc] [DOC] Make example formats explicit and consistent ( https://github.com/ruby/rdoc/pull/913 )
...
https://github.com/ruby/rdoc/commit/7e6ef6c855
2022-08-11 22:51:09 +09:00
Burdette Lamar
9fc401b689
[ruby/rdoc] Treat text markup (italic, bold, monofont) as blocks ( https://github.com/ruby/rdoc/pull/911 )
...
https://github.com/ruby/rdoc/commit/dc88f1b425
2022-08-11 06:18:39 +09:00
Burdette Lamar
26bed71959
[DOC] Adding a few standards-based formats ( #6227 )
2022-08-10 13:40:50 -05:00
Takashi Kokubun
f8936b3341
Remove documentation about dev
...
dev is Shopify's internal tool that doesn't work if you use Intel
Homebrew on M1 (or rbenv, btw). Now that we maintain this outside
Shopify's repository, we should stop talking about it here.
2022-08-08 19:02:30 -07:00
Nobuyoshi Nakada
289d219758
[ruby/date] [DOC] Fix about calendars difference
...
https://github.com/ruby/date/commit/0ae93e26aa
2022-08-08 21:14:10 +09:00
Burdette Lamar
1607c6d281
[DOC] New doc about Julian/Gregorian ( #70 )
2022-08-07 20:42:31 -04:00
Burdette Lamar
23a84d53c6
[ruby/rdoc] [DOC] Removes remaining old Markup Reference ( https://github.com/ruby/rdoc/pull/910 )
...
https://github.com/ruby/rdoc/commit/4e44c9c6cf
2022-08-07 21:07:23 +09:00
Peter Zhu
da00243dfe
[DOC] Specify ways to run bootstrap tests
2022-08-02 09:40:53 -04:00
Burdette Lamar
f78e46d404
[ruby/rdoc] Add block quotes ( https://github.com/ruby/rdoc/pull/907 )
...
Also adjusts which blocks may be nested.
https://github.com/ruby/rdoc/commit/dde1860441
2022-07-29 23:40:26 +09:00
Burdette Lamar
18b1e5e6db
[ruby/rdoc] [DOC] Add some links in intro; delimit rendered HTML output. ( https://github.com/ruby/rdoc/pull/904 )
...
https://github.com/ruby/rdoc/commit/c02645364f
2022-07-28 23:50:49 +09:00
Matt Valentine-House
70a9328b79
[ci-skip]Document how to run an individual bootstrap test
2022-07-27 09:16:04 -04:00
Burdette Lamar
64f9f7d855
[ruby/rdoc] [DOC] Clarifications for directives ( https://github.com/ruby/rdoc/pull/903 )
...
- Former section "Directives in Trailing Comments" is reworked. The important thing about a directive is what it does, not whether it's trailing or stand-alone. Therefore I've worked the directives in the former section into the appropriate sections, based on function.
- Each directive is now explicitly marked as trailing or stand-alone.
- C-code directives are mentioned only for those directives that actually appear in our ruby/ruby C files, which are :startdoc:, :stopdoc:, :enddoc:, :include:, and :call-seq:. What effect, if any, other directives have in C, I'm not sure about.
https://github.com/ruby/rdoc/commit/b00978bfa5
2022-07-27 05:06:56 +09:00
Peter Zhu
33f9e8f4ea
Add doc/rdoc directory to .document
...
Adding the doc/rdoc directory to .document will allow files in that
directory to be included in the documentation.
2022-07-26 12:31:47 -04:00
Burdette Lamar
cc29b43c7a
[ruby/rdoc] Move section Directives into section Blocks ( https://github.com/ruby/rdoc/pull/901 )
...
https://github.com/ruby/rdoc/commit/e48e07ef53
2022-07-26 06:31:36 +09:00
git
d7868c79e2
* append newline at EOF. [ci skip]
2022-07-26 05:29:28 +09:00
Peter Zhu
ba098fa151
Sync RDoc
2022-07-25 16:29:14 -04:00
Jeremy Evans
4813443837
Fix language describing protected methods
...
Fixes [Bug #18887 ]
2022-07-14 13:28:58 -07:00
Burdette Lamar
e3a988a29c
[DOC] Revisions for call-seq in doc guidelines ( #6121 )
...
Splits certain guidelines for singleton and instance method.
Calls for instance method to not prefix anything (like RDoc itself for a Ruby-coded instance method); e.g.:
count -> integer, not array.count,.
<=> other -> integer or nil, not hash <=> other -> integer or nil.
Groups previous guidelines into Arguments, Block, Return types, Aliases.
2022-07-12 20:49:24 -05:00
Burdette Lamar
8f5ad74e40
[DOC] New page for strftime formats ( #6074 )
...
This new page would be linked from method strftime in Time, Date, and DateTime, replacing the text there.
2022-07-01 15:25:05 -05:00
John Hawthorn
962a3247b1
Correct documentation for protected methods [ci skip]
2022-06-23 13:50:26 -07:00
Hiroshi SHIBATA
15769832b2
Added readline wrapper entries under the doc directory
2022-06-21 20:43:42 +09:00