aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* [ruby/optparse] Moved rdoc files to doc/optparseNobuyoshi Nakada2021-04-1151-0/+0
| | | | https://github.com/ruby/optparse/commit/cccb28e0de
* [ruby/optparse] Fix relative pathsNobuyoshi Nakada2021-04-111-2/+2
| | | | https://github.com/ruby/optparse/commit/8be031b539
* [ruby/optparse] More on tutorial (#16)Burdette Lamar2021-04-116-3/+180
| | | | | | | | | | | - 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
* [ruby/optparse] Rdoc (#15)Burdette Lamar2021-04-1110-365/+487
| | | | | | | | | | | | | | | | | | | | * 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
* [ruby/optparse] Reorganize Ruby example files for sharing (#14)Burdette Lamar2021-04-1145-55/+43
| | | | https://github.com/ruby/optparse/commit/9a2352c1c9
* [ruby/optparse] Make use of option_params.rdocBurdetteLamar2021-04-082-2/+9
| | | | https://github.com/ruby/optparse/commit/d55d9284c3
* [ruby/optparse] Enhanced doc for option parameters (#11)Burdette Lamar2021-04-0837-0/+1106
| | | | https://github.com/ruby/optparse/commit/5618eeb49e
* [ruby/optparse] More on tutorial (#9)Burdette Lamar2021-04-0810-54/+133
| | | | | | * More on tutorial: clearer example output https://github.com/ruby/optparse/commit/84dfd92d2a
* [ruby/optparse] Beginnings of tutorialBurdetteLamar2021-04-085-0/+154
| | | | https://github.com/ruby/optparse/commit/f209276f79
* Update method name and add documentation.Samuel Williams2021-03-301-1/+11
|
* [Doc] Update regex engine to Onigumo in doc/extension.* [ci skip]Kenichi Kamiya2021-03-272-4/+2
| | | regex.c has been removed in 8e65234086a15f90585bc09cce82dbad2aa647d7
* Pattern matching pin operator against expression [Feature #17411]Kazuki Tsujimoto2021-03-211-0/+1
| | | | This commit is based on the patch by @nobu.
* [Doc] Fix multiple `Magic Comments` exampleKenichi Kamiya2021-03-131-1/+1
| | | | [ci skip]
* [DOC] Fix copy+paste mistake [ci skip]Lars Kanis2021-02-231-1/+1
| | | It was introduced in commit 089b7a84606925e885fe91050483a352735aa91e .
* Improve extension docs, remove deprecated rb_cData [ci skip]Lars Kanis2021-02-221-9/+21
| | | | | | | | | | | | | | 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.
* [DOC] Improved regexp.rdoc [ci skip]Nobuyoshi Nakada2021-02-111-0/+10
| | | | | * Sub-sectioned "Repetition" section * Added examples of "Possessive match"
* Fix broken linkUse amazing-print instead2021-02-091-1/+1
| | | The document should point to doc/syntax/comments.rdoc (with an "s") as there currently no `doc/syntax/comment.rdoc`
* Improve the wording surrounding `Proc#isolate`Use amazing-print instead2021-02-091-2/+2
| | | | | | | | | | 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.
* Add File.absolute_path? to NEWS-2.7.0 [ci skip]Masataka Pocke Kuwabara2021-02-011-0/+9
| | | | | | | | `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>
* Update the maintainer of net-smtpHiroshi SHIBATA2021-01-171-1/+1
|
* Additions to method_documentation.rdoc (#4065)Burdette Lamar2021-01-151-2/+30
| | | * Additions to method_documentation.rdoc
* Typo fixes [doc]Marc-Andre Lafortune2021-01-121-10/+10
|
* Update wording in ractor.md (#4056) [doc]Adam Pogwizd2021-01-121-20/+20
|
* [DOC] Fix grammar: "is same as" -> "is the same as"Marcus Stollsteimer2021-01-054-5/+5
|
* NEWS-3.0.0: backquote a few code related words. [doc]Marc-Andre Lafortune2021-01-021-8/+8
|
* NEWS: We have links now, and there is no changelog anymore [doc]Marc-Andre Lafortune2021-01-021-4/+1
|
* doc/ractor.md: Fix indentationMarcus Stollsteimer2020-12-271-1/+2
| | | | | | | | 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 "-".
* [ruby/csv] fix typo conveters => converters for CSV parsing docs (#196)Sampat Badhe2020-12-271-2/+2
| | | | https://github.com/ruby/csv/commit/77ccf486fe
* doc/ractor.md: Fix indentation in code blocksMarcus Stollsteimer2020-12-261-144/+143
| | | | | | | Remove unnecessary indentation of code in code blocks (it is also not rendered properly in the generated HTML). Also remove an empty line.
* methods.rdoc: Improve method definition documentationMarcus Stollsteimer2020-12-261-18/+20
| | | | | | | * 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
* methods.rdoc: Clarify "currently" means "in 2.7" hereMarcus Stollsteimer2020-12-261-1/+1
|
* Update method definition documentationzverok2020-12-251-0/+86
| | | | | * Add endless methods * Add argument forwarding ...
* Adjusted the heading level of "Block Arguments" [ci skip]Nobuyoshi Nakada2020-12-251-1/+1
|
* Copy NEWS.md to doc/NEWS-3.0.0.md and update for 3.1.0Kazuhiro NISHIYAMA2020-12-251-0/+820
|
* [memory_view] Add documentation [ci skip]Kenta Murata2020-12-251-0/+167
|
* doc/syntax/pattern_matching.rdoc: fix typos, grammar, styleMarcus Stollsteimer2020-12-241-23/+23
|
* doc/extension.ja.rdoc: remove trailing whitespaceMarcus Stollsteimer2020-12-241-2/+2
|
* doc/keywords.rdoc: fix typoMarcus Stollsteimer2020-12-241-1/+1
|
* doc/maintainers.rdoc: typoYusuke Endoh2020-12-241-1/+1
|
* update doc/ractor.mdKoichi Sasada2020-12-241-81/+129
|
* doc/keywords.rdoc: mention pattern matching in the `in` keyword sectionYusuke Endoh2020-12-241-0/+2
|
* doc/contributing.rdoc: remove outdated contentYusuke Endoh2020-12-241-19/+0
|
* Tweak magic comments [doc]Marc-Andre Lafortune2020-12-241-9/+9
|
* remove redundant example.Koichi Sasada2020-12-241-1/+0
| | | | pointed by @marcandre.
* shareable_constant_value: experimental_copyKoichi Sasada2020-12-241-5/+30
| | | | | | | "experimental_everything" makes the assigned value, it means the assignment change the state of assigned value. "experimental_copy" tries to make a deep copy and make copyied object sharable.
* add about Ractor into extension.rdoc [ci skip]Koichi Sasada2020-12-242-0/+102
|
* doc/fiber.md: fix typosMarcus Stollsteimer2020-12-231-2/+2
|
* Small improvements in magic comments docsMarcus Stollsteimer2020-12-231-13/+13
| | | | | | * remove a duplicate statement * fix rdoc markup * fix typos
* Document shareable_constant_value and other magic constants [doc]Marc-Andre Lafortune2020-12-231-0/+192
|
* Fix a message in example codeKazuki Tsujimoto2020-12-231-1/+1
| | | | Thanks to @zverok for the report.