summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2021-05-11Update keyword argument description in method syntax guideJeremy Evans
Remove discussion of Ruby 2.7 specific handling of keyword argument separation. Add a small example of keyword to positional hash conversion for methods not accepting keyword arguments.
2021-05-07What's Here for class Dir (#4472)Burdette Lamar
What's Here for class Dir Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2021-04-29Update Time documentationBurdette Lamar
2021-04-26Fix some typos by spell checkerRyuta Kamizono
Notes: Merged: https://github.com/ruby/ruby/pull/4414
2021-04-25[Doc] Fix a typo s/evel/eval/wonda-tea-coffee
Notes: Merged: https://github.com/ruby/ruby/pull/4408
2021-04-25[Doc] Fix a typo s/invokations/invocations/wonda-tea-coffee
Notes: Merged: https://github.com/ruby/ruby/pull/4409
2021-04-11[ruby/optparse] Moved rdoc files to doc/optparseNobuyoshi Nakada
https://github.com/ruby/optparse/commit/cccb28e0de
2021-04-11[ruby/optparse] Fix relative pathsNobuyoshi Nakada
https://github.com/ruby/optparse/commit/8be031b539
2021-04-11[ruby/optparse] More on tutorial (#16)Burdette Lamar
- Added example in "Argument Converters"; it doesn't seem right for a tutorial to have no example in one of its topics (and instead just linking elsewhere). - Added section "Command-Line Abbreviations." - Added section "Keyword Argument into," showing how to: - Collect options. - Check for missing options. - Provide option defaults. https://github.com/ruby/optparse/commit/39d39676c4
2021-04-11[ruby/optparse] Rdoc (#15)Burdette Lamar
* Resolve shared mixed_names.rb * Add long option with negation * Show --help for all examples * Table of contents for tutorial * Move argument converters to separate rdoc * Add references to argument_converters.rdoc * Tune up argument converters * Change explicit links to auto-links https://github.com/ruby/optparse/commit/c91ed8d33d
2021-04-11[ruby/optparse] Reorganize Ruby example files for sharing (#14)Burdette Lamar
https://github.com/ruby/optparse/commit/9a2352c1c9
2021-04-08[ruby/optparse] Make use of option_params.rdocBurdetteLamar
https://github.com/ruby/optparse/commit/d55d9284c3
2021-04-08[ruby/optparse] Enhanced doc for option parameters (#11)Burdette Lamar
https://github.com/ruby/optparse/commit/5618eeb49e
2021-04-08[ruby/optparse] More on tutorial (#9)Burdette Lamar
* More on tutorial: clearer example output https://github.com/ruby/optparse/commit/84dfd92d2a
2021-04-08[ruby/optparse] Beginnings of tutorialBurdetteLamar
https://github.com/ruby/optparse/commit/f209276f79
2021-03-30Update method name and add documentation.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/4173
2021-03-27[Doc] Update regex engine to Onigumo in doc/extension.* [ci skip]Kenichi Kamiya
regex.c has been removed in 8e65234086a15f90585bc09cce82dbad2aa647d7 Notes: Merged: https://github.com/ruby/ruby/pull/4306 Merged-By: nobu <nobu@ruby-lang.org>
2021-03-21Pattern matching pin operator against expression [Feature #17411]Kazuki Tsujimoto
This commit is based on the patch by @nobu.
2021-03-13[Doc] Fix multiple `Magic Comments` exampleKenichi Kamiya
[ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4264
2021-02-23[DOC] Fix copy+paste mistake [ci skip]Lars Kanis
It was introduced in commit 089b7a84606925e885fe91050483a352735aa91e . Notes: Merged: https://github.com/ruby/ruby/pull/4211
2021-02-22Improve extension docs, remove deprecated rb_cData [ci skip]Lars Kanis
rb_cData is deprecated and the characteristic alloc_func was already removed in ruby-3.0. So this updates the recommendation accordingly. It also adds fdbm_alloc() in order to show the allocation process and to gives TypedData_Make_Struct() more context. Moreover it describes fdbm_aref(), so that the relation to rb_define_method() is shown. And fdbm_aref() makes use of GetDBM() now, to show how this macro might be used. Notes: Merged: https://github.com/ruby/ruby/pull/4208 Merged-By: nobu <nobu@ruby-lang.org>
2021-02-11[DOC] Improved regexp.rdoc [ci skip]Nobuyoshi Nakada
* Sub-sectioned "Repetition" section * Added examples of "Possessive match"
2021-02-09Fix broken linkUse amazing-print instead
The document should point to doc/syntax/comments.rdoc (with an "s") as there currently no `doc/syntax/comment.rdoc` Notes: Merged: https://github.com/ruby/ruby/pull/4162
2021-02-09Improve the wording surrounding `Proc#isolate`Use amazing-print instead
This change moves the statement that `Proc#isolate` isn't yet exposed for Ruby users to the first time the method is mentioned. This is so that readers don't waste time trying to look it up in Ruby docs. There was also unnecessary duplication: ``` Paragraph 1: "Given block will be isolated from outer scope by Proc#isolate." Paragraph 2: "Given block will be isolated by Proc#isolate method" ``` So I combined the two sentences and slightly improved the wording for clarity. Notes: Merged: https://github.com/ruby/ruby/pull/4161
2021-02-01Add File.absolute_path? to NEWS-2.7.0 [ci skip]Masataka Pocke Kuwabara
`File.absolute_path?` has been added since Ruby 2.7.0, but it isn't mentioned in the NEWS. So this patch adds a NEWS entry. ref: https://bugs.ruby-lang.org/issues/15868 Co-authored-by: nagachika <nagachika@ruby-lang.org> Notes: Merged: https://github.com/ruby/ruby/pull/4139 Merged-By: nobu <nobu@ruby-lang.org>
2021-01-17Update the maintainer of net-smtpHiroshi SHIBATA
2021-01-15Additions to method_documentation.rdoc (#4065)Burdette Lamar
* Additions to method_documentation.rdoc Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2021-01-12Typo fixes [doc]Marc-Andre Lafortune
2021-01-12Update wording in ractor.md (#4056) [doc]Adam Pogwizd
Notes: Merged-By: marcandre <github@marc-andre.ca>
2021-01-05[DOC] Fix grammar: "is same as" -> "is the same as"Marcus Stollsteimer
2021-01-02NEWS-3.0.0: backquote a few code related words. [doc]Marc-Andre Lafortune
2021-01-02NEWS: We have links now, and there is no changelog anymore [doc]Marc-Andre Lafortune
2020-12-27doc/ractor.md: Fix indentationMarcus Stollsteimer
Reintroduce removed empty line to fix indentation on rendered page (the first line is _not_ indented despite the leading spaces, and ends up "outdented" compared to the rest of the block). Also add a missing "-".
2020-12-27[ruby/csv] fix typo conveters => converters for CSV parsing docs (#196)Sampat Badhe
https://github.com/ruby/csv/commit/77ccf486fe
2020-12-26doc/ractor.md: Fix indentation in code blocksMarcus Stollsteimer
Remove unnecessary indentation of code in code blocks (it is also not rendered properly in the generated HTML). Also remove an empty line.
2020-12-26methods.rdoc: Improve method definition documentationMarcus Stollsteimer
* typos, grammar, formatting * use `concrete_method` again in `regular_method` example, to better distinguish from `forwarding_method` example * clarify that leading arguments before `...` require Ruby 3.0
2020-12-26methods.rdoc: Clarify "currently" means "in 2.7" hereMarcus Stollsteimer
2020-12-25Update method definition documentationzverok
* Add endless methods * Add argument forwarding ... Notes: Merged: https://github.com/ruby/ruby/pull/3997
2020-12-25Adjusted the heading level of "Block Arguments" [ci skip]Nobuyoshi Nakada
2020-12-25Copy NEWS.md to doc/NEWS-3.0.0.md and update for 3.1.0Kazuhiro NISHIYAMA
2020-12-25[memory_view] Add documentation [ci skip]Kenta Murata
2020-12-24doc/syntax/pattern_matching.rdoc: fix typos, grammar, styleMarcus Stollsteimer
2020-12-24doc/extension.ja.rdoc: remove trailing whitespaceMarcus Stollsteimer
2020-12-24doc/keywords.rdoc: fix typoMarcus Stollsteimer
2020-12-24doc/maintainers.rdoc: typoYusuke Endoh
2020-12-24update doc/ractor.mdKoichi Sasada
2020-12-24doc/keywords.rdoc: mention pattern matching in the `in` keyword sectionYusuke Endoh
2020-12-24doc/contributing.rdoc: remove outdated contentYusuke Endoh
2020-12-24Tweak magic comments [doc]Marc-Andre Lafortune
2020-12-24remove redundant example.Koichi Sasada
pointed by @marcandre.
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-28 16:58:56 +0000