summaryrefslogtreecommitdiff
path: root/doc/syntax
AgeCommit message (Collapse)Author
2025-12-23Describe base code layout rules (#15696)Victor Shepelev
* Describe base code layout rules * Enhance optional keyword explanation * Change the logical operators description
2025-12-20Small documentation adjustments for new/updated features (#15634)Victor Shepelev
* Document Range#to_set * Update Thread#raise and Fiber#raise signatures and docs * Add reference to String#strip to character_selectors.rdoc * Update *nil docs when calling methods * Enhance Array#find and #rfind docs * Add a notice to Kernel#raise about cause:
2025-12-05fix typo s/sharable/shareable/Koichi Sasada
2025-11-27Reorganize page documentations (#15154)Stan Lo
Re-organize page docs
2025-11-27Documentation: Added the `|`(pipe)/OR operator to syntax/methods.Sebastian Dufner
It was not documented as an operator that can be overriden, which is confusing because it makes you think it can't be.
2025-11-23[DOC] Remove the name from same file referencesNobuyoshi Nakada
2025-11-17Remove alternation pattern matching handling from the prism compilerEarlopain
Since https://github.com/ruby/ruby/pull/15212 these are proper syntax errors, so no need to handle this explicitly anymore. Also updated the example in the docs for this
2025-11-08[DOC] Tweaks for String#to_cBurdette Lamar
2025-10-29[DOC] Update refinements.rdocAstra
removes documentation for the activation order of `include` and `prepend` inside a refinement
2025-08-11[DOC] New .md file to replace doc/globals.rdocBurdette Lamar
2025-04-24Fix tiny typo in syntax/exceptions.rdocMasafumi Koba
Notes: Merged: https://github.com/ruby/ruby/pull/13171
2025-03-21Escape `Binding` reference in pattern matching docsJoshua Young
Notes: Merged: https://github.com/ruby/ruby/pull/12955
2025-03-13[DOC] Correct output in calling_methods.rdocYutaro Ohno
Notes: Merged: https://github.com/ruby/ruby/pull/12912
2025-01-07[DOC] Fix an error exampleNobuyoshi Nakada
`%q{c}` after another string literal is parsed as RHS of modulo, `q` method call with a block.
2025-01-07Move string escape sequence documention further downEarlopain
If someone looks at documention for strings, I don't think escape sequences is what they look for in majority of the cases. Notes: Merged: https://github.com/ruby/ruby/pull/12318
2025-01-07Fix link to strings in literals.rdocEarlopain
Since https://github.com/ruby/ruby/commit/5e1001f754b34e1f0cc67563512c6036b6eb75ab, the string link is broken Instead of changing the anchor reference, I changed the header directly, to keep in line with other titles Notes: Merged: https://github.com/ruby/ruby/pull/12318
2025-01-02[DOC] Exclude 'Method' from RDoc's autolinkingNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12496
2024-12-22s/backslashs/backslashes/ydah
Notes: Merged: https://github.com/ruby/ruby/pull/12426
2024-12-18[DOC] Fix output examples containing old Hash#inspect formattomoya ishida
The inspect format was intentionally changed as an outcome of [Bug #20433] [ruby-core:118668], but some documentation update was missing, as [Bug #20962] pointed out. Update some output examples that clearly use Hash#inspect. Notes: Merged: https://github.com/ruby/ruby/pull/12384 Merged-By: XrXr
2024-12-15[DOC] Adjust argument unpacking docs and document **nil (#12228)Victor Shepelev
[DOC] Rewrite argument unpacking docs and document **nil Notes: Merged-By: zverok <zverok.offline@gmail.com>
2024-12-13[DOC] Move the comma outside the `<tt>` tagNobuyoshi Nakada
2024-09-25doc: Remove description of experimental warnings related pattern matching ↵masatoshi_moritsuka
from documentation Ruby 3.2.0 has been released and all experimental warnings about pattern matching have been removed. Experimental warnings about pattern matching are no longer output, so I remove description about it from documentation as well. cf. https://bugs.ruby-lang.org/issues/18585 cf. db6b23c76cbc7888cd9a9912790c2068703afdd0 cf. https://twitter.com/k_tsj/status/1606956336037900289?s=20&t=-_PSYLhYPtYsB9FZhtXl5A Notes: Merged: https://github.com/ruby/ruby/pull/7052
2024-09-10[DOC] Fix linkBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11528
2024-08-21[DOC] Include keywords.rdoc in doc/syntax/ (#11414)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2024-06-07[DOC] document line continuation.Tanaka Akira
Document details of escape sequences including line continuation. [Bug #20518]
2024-06-03fix typos.Tanaka Akira
2024-06-03[DOC] percent literals can be nested.Tanaka Akira
2024-05-12[Bug #20482] [DOC] Clarify about pattern maching guard clauseNobuyoshi Nakada
Guard clauses can only be used in `case` pattern matching statements, not in `=>`/`in` operators.
2024-03-27[DOC] remove repetitive words in commentscrazeteam
Signed-off-by: crazeteam <lilujing@outlook.com>
2024-03-15[DOC] exceptions.rdoc : Add heads up about ensure not returning implicitlyPierre Merlin
There is a weird gotcha I already forgot twice.... and regret not to have found in doc. See https://dev.to/okuramasafumi/be-sure-ensure-doesn-t-return-value-implicitly-8gp
2024-02-15s/ therefor/therefore/ydah
2023-12-26[DOC] Fix == and === in control_expressions.rdocPeter Zhu
2023-12-27[Bug #20087] [DOC] Uninitialized instance variable is not warned nowNobuyoshi Nakada
2023-12-25Typofix under doc directoryHiroshi SHIBATA
2023-12-19[DOC] remove reference to pre-3.0 splat operator behaviorDoug Orleans
2023-10-22[DOC] Mention the omission of a superclass when reopening a classKouhei Yanagita
2023-09-20doc: initial operators commitNicholas Browning
docs: expand on operator documentaion Include more specific details around logical operators. doc: update link with proper syntax doc: remove ambiguous language from operators doc doc: remove link to source code file doc: cleaning up some language, and removing some mistakes in understanding doc: revert example to prior state doc: fix spacing doc: Update doc/syntax/operators.rdoc align example with typical format Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> doc: Update doc/syntax/operators.rdoc align format of other examples with rest of documentation Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> Update doc/syntax/operators.rdoc align format of other examples with rest of documentation Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> doc: include `and` & `or` operators doc(operators): remove accute language
2023-07-18[DOC] Fix a magic comment in the section for `experimental_copy`Ivanov-Anton
Notes: Merged: https://github.com/ruby/ruby/pull/8087 Merged-By: nobu <nobu@ruby-lang.org>
2023-06-29Fix broken wiki links (#8002)Jemma Issroff
Since [Misc #19679] migrated the wiki, these links should be updated to their new locations. Notes: Merged-By: jemmaissroff
2023-06-20[DOC] Regexp doc (#7923)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-05-26Document throw/catch in the control expressions document [ci skip]Jeremy Evans
This are implemented as Kernel methods and not keywords, but I still think they are worth documenting with the other control flow expressions. Notes: Merged: https://github.com/ruby/ruby/pull/7856 Merged-By: jeremyevans <code@jeremyevans.net>
2023-03-19[Bug #19485] [DOC] Mention tabs in indentation of heredoc identifierNobuyoshi Nakada
Co-Authored-By: sawa (Tsuyoshi Sawada) <sawadatsuyoshi@gmail.com> Notes: Merged: https://github.com/ruby/ruby/pull/7526
2023-02-19[DOC] Update pattern matching docs for 3.2zverok
* Remove section about experimental status * Add references to core objects that can deconstruct Notes: Merged: https://github.com/ruby/ruby/pull/7316
2023-02-15[DOC] Add an example of the splat operator with a non-array object (#7098)Kouhei Yanagita
Notes: Merged-By: hsbt <hsbt@ruby-lang.org>
2023-01-23[DOC] Change local method to local variable in assignment docsTalal Al-Humaidi
Notes: Merged: https://github.com/ruby/ruby/pull/7173 Merged-By: nobu <nobu@ruby-lang.org>
2022-07-14Fix language describing protected methodsJeremy Evans
Fixes [Bug #18887]
2022-06-23Correct documentation for protected methods [ci skip]John Hawthorn
2022-05-12Quick markup fixAlexey Mostovoy
Notes: Merged: https://github.com/ruby/ruby/pull/5902
2022-04-25[DOC] mention assignment expression valuesNobuyoshi Nakada
2022-04-24More details for Rational literals (#5840)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>