summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2022-09-27[DOC] More on IO streams (#6454)Burdette Lamar
Adds remarks about .new and .open. Uses ..open where convenient (not convenient where output would be in a block). Fixed examples for #ungetc. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-09-27[DOC] More on IO streams (#6445)Burdette Lamar
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. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-09-23[DOC] Housekeeping in iostreams doc (#6420)Burdette Lamar
Write some method names in linkable form; make some capitalization consistent. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-09-21New page IO Streams (#6383)Burdette Lamar
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. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-09-21Add URI.escape and URI.unescape to NEWS-3.0.0 [ci skip]Akihiro Sada
Notes: Merged: https://github.com/ruby/ruby/pull/5764
2022-09-19Stop recommending duplicated options [ci skip] (#6400)Takashi Kokubun
Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2022-09-05[DOC] [Bug #17120] Fix match-reset `\K`Nobuyoshi Nakada
2022-09-05Stop testing MJIT on s390xTakashi Kokubun
It didn't work either. http://rubyci.s3.amazonaws.com/s390x/ruby-master/log/20220905T080003Z.fail.html.gz
2022-09-05Update MJIT doc about bindgen and platforms [ci skip]Takashi Kokubun
2022-09-03[DOC] Escape backqoute method not to be converted to smart quotesNobuyoshi Nakada
2022-08-31It was a relative path [ci skip]Takashi Kokubun
2022-08-31Add a document about YJIT's Rust versionTakashi Kokubun
2022-08-31[DOC] Enhanced RDoc for Time (#6308)Burdette Lamar
More on timezones. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-30Put a documentation about MJIT [ci skip]Takashi Kokubun
2022-08-29Update yjit.mdMaxime Chevalier-Boisvert
Add VMIL paper, update supported CPUs. Notes: Merged: https://github.com/ruby/ruby/pull/6289
2022-08-25[DOC] Enhanced RDoc for Time (#6277)Burdette Lamar
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 Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-22[DOC] Addition to section 'Related Methods' (#6271)Burdette Lamar
Addition to section 'Related Methods': suggests adding differentiators to the names of related methods. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-22[DOC] Enhanced RDoc for Time (#6267)Burdette Lamar
Treats: #utc #getlocal #getutc #ctime #to_s #inspect Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-22[DOC] Fix a type [ci skip]Nobuyoshi Nakada
2022-08-22[DOC] Remove extra page-dir prefixNobuyoshi Nakada
2022-08-21[DOC] Enhanced RDoc for Time (#6255)Burdette Lamar
Treats: #utc #hash #localtime Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-19[DOC] Fix "military timezone"Nobuyoshi Nakada
Not only `J` is called military timezone.
2022-08-16[ruby/rdoc] [DOC] Remove duplicated line in RDoc::MarkupReferencePeter Zhu
https://github.com/ruby/rdoc/commit/488f89aee4
2022-08-13[ruby/rdoc] [DOC] Enhances text about escapes ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/917) https://github.com/ruby/rdoc/commit/c40bac829c
2022-08-12[ruby/rdoc] Mods to section Text Markup (https://github.com/ruby/rdoc/pull/916)Burdette Lamar
https://github.com/ruby/rdoc/commit/5506d4d67e
2022-08-12[ruby/rdoc] Improvements to Text Markup examples ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/915) https://github.com/ruby/rdoc/commit/d00ddfe57c
2022-08-11[ruby/rdoc] [DOC] Make example formats explicit and consistent ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/913) https://github.com/ruby/rdoc/commit/7e6ef6c855
2022-08-11[ruby/rdoc] Treat text markup (italic, bold, monofont) as blocks ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/911) https://github.com/ruby/rdoc/commit/dc88f1b425
2022-08-10[DOC] Adding a few standards-based formats (#6227)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-08Remove documentation about devTakashi Kokubun
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[ruby/date] [DOC] Fix about calendars differenceNobuyoshi Nakada
https://github.com/ruby/date/commit/0ae93e26aa
2022-08-07[DOC] New doc about Julian/Gregorian (#70)Burdette Lamar
2022-08-07[ruby/rdoc] [DOC] Removes remaining old Markup Reference ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/910) https://github.com/ruby/rdoc/commit/4e44c9c6cf
2022-08-02[DOC] Specify ways to run bootstrap testsPeter Zhu
Notes: Merged: https://github.com/ruby/ruby/pull/6194
2022-07-29[ruby/rdoc] Add block quotes (https://github.com/ruby/rdoc/pull/907)Burdette Lamar
Also adjusts which blocks may be nested. https://github.com/ruby/rdoc/commit/dde1860441
2022-07-28[ruby/rdoc] [DOC] Add some links in intro; delimit rendered HTML output. ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/904) https://github.com/ruby/rdoc/commit/c02645364f
2022-07-27[ci-skip]Document how to run an individual bootstrap testMatt Valentine-House
Notes: Merged: https://github.com/ruby/ruby/pull/6190
2022-07-27[ruby/rdoc] [DOC] Clarifications for directives ↵Burdette Lamar
(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-26Add doc/rdoc directory to .documentPeter Zhu
Adding the doc/rdoc directory to .document will allow files in that directory to be included in the documentation.
2022-07-26[ruby/rdoc] Move section Directives into section Blocks ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/901) https://github.com/ruby/rdoc/commit/e48e07ef53
2022-07-26* append newline at EOF. [ci skip]git
2022-07-25Sync RDocPeter Zhu
Notes: Merged: https://github.com/ruby/ruby/pull/6182
2022-07-14Fix language describing protected methodsJeremy Evans
Fixes [Bug #18887]
2022-07-12[DOC] Revisions for call-seq in doc guidelines (#6121)Burdette Lamar
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. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-07-01[DOC] New page for strftime formats (#6074)Burdette Lamar
This new page would be linked from method strftime in Time, Date, and DateTime, replacing the text there. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-06-23Correct documentation for protected methods [ci skip]John Hawthorn
2022-06-21Added readline wrapper entries under the doc directoryHiroshi SHIBATA
2022-06-21Added error_highlight entries under the doc directoryHiroshi SHIBATA
2022-06-21Added reline entry to standard_library docHiroshi SHIBATA
2022-06-20[Feature #18788] [DOC] String options to `Regexp.new`Nobuyoshi Nakada
Co-Authored-By: Janosch Müller <janosch.mueller@betterplace.org> Notes: Merged: https://github.com/ruby/ruby/pull/6039