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

821 Коммитов

Автор SHA1 Сообщение Дата
Nobuyoshi Nakada f89486965b [ruby/optparse] Moved rdoc files to doc/optparse
https://github.com/ruby/optparse/commit/cccb28e0de
2021-04-11 09:03:36 +09:00
Nobuyoshi Nakada cb01437c24 [ruby/optparse] Fix relative paths
https://github.com/ruby/optparse/commit/8be031b539
2021-04-11 08:52:58 +09:00
Burdette Lamar 1bad4bdf52 [ruby/optparse] More on tutorial (#16)
-   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 08:52:54 +09:00
Burdette Lamar ff0dac1849 [ruby/optparse] Rdoc (#15)
* 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 08:52:52 +09:00
Burdette Lamar c795f30ef0 [ruby/optparse] Reorganize Ruby example files for sharing (#14)
https://github.com/ruby/optparse/commit/9a2352c1c9
2021-04-11 08:52:50 +09:00
BurdetteLamar a5ecce9187
[ruby/optparse] Make use of option_params.rdoc
https://github.com/ruby/optparse/commit/d55d9284c3
2021-04-08 12:11:42 +09:00
Burdette Lamar 5891159f96
[ruby/optparse] Enhanced doc for option parameters (#11)
https://github.com/ruby/optparse/commit/5618eeb49e
2021-04-08 12:11:42 +09:00
Burdette Lamar fe72cff487
[ruby/optparse] More on tutorial (#9)
* More on tutorial: clearer example output

https://github.com/ruby/optparse/commit/84dfd92d2a
2021-04-08 12:11:32 +09:00
BurdetteLamar 0d1d779c23 [ruby/optparse] Beginnings of tutorial
https://github.com/ruby/optparse/commit/f209276f79
2021-04-08 12:09:29 +09:00
Samuel Williams 511acba4ae Update method name and add documentation. 2021-03-30 18:38:42 +13:00
Kenichi Kamiya 31ae931e16
[Doc] Update regex engine to Onigumo in doc/extension.* [ci skip]
regex.c has been removed in 8e65234086
2021-03-27 17:22:57 +09:00
Kazuki Tsujimoto 21863470d9
Pattern matching pin operator against expression [Feature #17411]
This commit is based on the patch by @nobu.
2021-03-21 15:14:31 +09:00
Kenichi Kamiya c7e6914b39 [Doc] Fix multiple `Magic Comments` example
[ci skip]
2021-03-13 15:44:34 +09:00
Lars Kanis 09c74a1702 [DOC] Fix copy+paste mistake [ci skip]
It was introduced in commit 089b7a8460 .
2021-02-23 10:48:31 +09:00
Lars Kanis 089b7a8460
Improve extension docs, remove deprecated rb_cData [ci skip]
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.
2021-02-22 12:18:16 +09:00
Nobuyoshi Nakada f3f78f9654
[DOC] Improved regexp.rdoc [ci skip]
* Sub-sectioned "Repetition" section
* Added examples of "Possessive match"
2021-02-11 22:20:41 +09:00
Use amazing-print instead 189bf0106f Fix broken link
The document should point to doc/syntax/comments.rdoc (with an "s") as there currently no `doc/syntax/comment.rdoc`
2021-02-09 13:16:32 -08:00
Use amazing-print instead e7a831de8e Improve the wording surrounding `Proc#isolate`
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.
2021-02-09 08:22:37 -05:00
Masataka Pocke Kuwabara 23a833ee67
Add File.absolute_path? to NEWS-2.7.0 [ci skip]
`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>
2021-02-01 14:01:47 +09:00
Hiroshi SHIBATA 19902e2e0a
Update the maintainer of net-smtp 2021-01-17 08:14:02 +09:00
Burdette Lamar e7f1afbccd
Additions to method_documentation.rdoc (#4065)
* Additions to method_documentation.rdoc
2021-01-15 14:25:56 -06:00
Marc-Andre Lafortune 65787f18b9 Typo fixes [doc] 2021-01-12 23:30:47 -05:00
Adam Pogwizd 75212f2fc6
Update wording in ractor.md (#4056) [doc] 2021-01-12 23:28:34 -05:00
Marcus Stollsteimer 3108ad7bf3 [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
Marc-Andre Lafortune a495cb2fd5 NEWS-3.0.0: backquote a few code related words. [doc] 2021-01-02 21:55:03 -05:00
Marc-Andre Lafortune fdf3539967 NEWS: We have links now, and there is no changelog anymore [doc] 2021-01-02 21:54:00 -05:00
Marcus Stollsteimer 228ad7d84b doc/ractor.md: Fix indentation
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 22:39:42 +01:00
Sampat Badhe 677ccb927c [ruby/csv] fix typo conveters => converters for CSV parsing docs (#196)
https://github.com/ruby/csv/commit/77ccf486fe
2020-12-27 15:27:03 +09:00
Marcus Stollsteimer ab6adf2772 doc/ractor.md: Fix indentation in code blocks
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-26 22:51:48 +01:00
Marcus Stollsteimer 3fc53de5c9 methods.rdoc: Improve method definition documentation
* 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-26 10:40:52 +01:00
Marcus Stollsteimer ce65a7687f methods.rdoc: Clarify "currently" means "in 2.7" here 2020-12-26 10:40:47 +01:00
zverok 255ee4de8c Update method definition documentation
* Add endless methods
* Add argument forwarding ...
2020-12-25 22:10:09 +09:00
Nobuyoshi Nakada aaf0474e76
Adjusted the heading level of "Block Arguments" [ci skip] 2020-12-25 22:09:22 +09:00
Kazuhiro NISHIYAMA 7e3d710a22
Copy NEWS.md to doc/NEWS-3.0.0.md and update for 3.1.0 2020-12-25 17:31:48 +09:00
Kenta Murata 9b091084a1
[memory_view] Add documentation [ci skip] 2020-12-25 01:44:54 +09:00
Marcus Stollsteimer 9f9a389d95 doc/syntax/pattern_matching.rdoc: fix typos, grammar, style 2020-12-24 11:35:03 +01:00
Marcus Stollsteimer a4419a55f0 doc/extension.ja.rdoc: remove trailing whitespace 2020-12-24 11:31:06 +01:00
Marcus Stollsteimer c601a7ecfd doc/keywords.rdoc: fix typo 2020-12-24 11:30:30 +01:00
Yusuke Endoh 1a74fb011d doc/maintainers.rdoc: typo 2020-12-24 18:03:39 +09:00
Koichi Sasada 8664c3ddef update doc/ractor.md 2020-12-24 17:51:47 +09:00
Yusuke Endoh 85f0179479 doc/keywords.rdoc: mention pattern matching in the `in` keyword section 2020-12-24 17:15:24 +09:00
Yusuke Endoh 1729fd8c0a doc/contributing.rdoc: remove outdated content 2020-12-24 17:00:30 +09:00
Marc-Andre Lafortune 8aa299de24 Tweak magic comments [doc] 2020-12-24 01:36:08 -05:00
Koichi Sasada e43b5aa52d remove redundant example.
pointed by @marcandre.
2020-12-24 14:31:01 +09:00
Koichi Sasada 6f29716f9f shareable_constant_value: experimental_copy
"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.
2020-12-24 14:28:47 +09:00
Koichi Sasada 9aca51e8a5 add about Ractor into extension.rdoc [ci skip] 2020-12-24 12:10:17 +09:00
Marcus Stollsteimer ae26d5bd41 doc/fiber.md: fix typos 2020-12-23 21:56:04 +01:00
Marcus Stollsteimer 458d5175b9 Small improvements in magic comments docs
* remove a duplicate statement
* fix rdoc markup
* fix typos
2020-12-23 19:47:26 +01:00
Marc-Andre Lafortune 8feb40f49a Document shareable_constant_value and other magic constants [doc] 2020-12-23 11:50:33 -05:00
Kazuki Tsujimoto b222a1a494
Fix a message in example code
Thanks to @zverok for the report.
2020-12-23 02:37:27 +09:00