summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2024-07-07[DOC] Fix typo `with` -> `wish`cdfzo
2024-07-05[DOC] yjit.md: Markdown fixes for RDocAlan Wu
It now renders properly on both GitHub and with RDoc's darkfish theme.
2024-07-01[ruby/irb] fix typos in the `Index of Command-Line Options`Anatoly Busygin
https://github.com/ruby/irb/commit/3512020f1c
2024-06-26[DOC] Doc for exceptions (#11008)Burdette Lamar
2024-06-26Mentioned new mswin tasks related with vcpkgHiroshi SHIBATA
2024-06-26Added git for requirements of Windows buildHiroshi SHIBATA
2024-06-19String.new(capacity:) don't substract termlenJean Boussier
[Bug #20585] This was changed in 36a06efdd9f0604093dccbaf96d4e2cb17874dc8 because `String.new(1024)` would end up allocating `1025` bytes, but the problem with this change is that the caller may be trying to right size a String. So instead, we should just better document the behavior of `capacity:`.
2024-06-09Correct typo [ci skip]Sampat Badhe
2024-06-09[Bug #20566] Mention out-of-range argument cases in `String#<<`Nobuyoshi Nakada
Also [Bug #18973].
2024-06-07[DOC] document line continuation.Tanaka Akira
Document details of escape sequences including line continuation. [Bug #20518]
2024-06-04[DOC] Exceptions doc (#10865)Burdette Lamar
2024-06-04Removed trailing spaces.Hiroshi SHIBATA
2024-06-04Sync strscan HEAD again.Hiroshi SHIBATA
https://github.com/ruby/strscan/pull/99 split document with multi-byte chars.
2024-06-03fix typos.Tanaka Akira
2024-06-03[DOC] percent literals can be nested.Tanaka Akira
2024-06-02[DOC] building_ruby: Move the caution to a footnoteNobuyoshi Nakada
2024-06-02[DOC] building_ruby: External library linksNobuyoshi Nakada
- `OpenSSL` here is not the class. - libexecinfo on FreeBSD is present in the base system of all supported releases, since 2017.
2024-06-02[DOC] building_ruby: Refine linksNobuyoshi Nakada
Get rid of using ambiguous demonstratives as link anchors, for the accessibility's sake.
2024-06-02[DOC] building_ruby: Fold long linesNobuyoshi Nakada
2024-06-02[DOC] Caution about old GNU makeNobuyoshi Nakada
2024-05-30Revert "[ruby/strscan] Doc for StringScanner"Hiroshi SHIBATA
This reverts commit 974ed1408c516d1e8f992f0b304e2de6f8bd5c1f.
2024-05-30Revert "Fix reference path for strscan documentation"Hiroshi SHIBATA
This reverts commit 1fa93fb9488a32018101689fd727965fd5874eb5.
2024-05-30Fix reference path for strscan documentationHiroshi SHIBATA
2024-05-30[ruby/strscan] Doc for StringScannerBurdette Lamar
(https://github.com/ruby/strscan/pull/96) #peek_byte and #scan_byte not updated (not available in my repo -- sorry). --------- https://github.com/ruby/strscan/commit/0123da7352 Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
2024-05-14[DOC] Fix typo in example code for `String#encode` methodAlexander Ross
The example code in the documentation for the `String#encode` method has a typo in the `fallback` option. The example code uses `h` as the fallback option, but it should use `hash` instead to match the variable name in the example code.
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-05-10Update ASAN docs to refer to Clang 18's releaseKJ Tsanaktsidis
Clang 18 has the bugfix we need, so we no longer need to tell people to compile Clang from source.
2024-04-26[DOC] Fix a typo in globals.rdoc Diego Henrique
Noticed this small type while reading the docs.
2024-04-26[DOC] Caveat about "allocate then wrap"Nobuyoshi Nakada
2024-04-24Removed obsoleted section because make docs is removed from default make taskHiroshi SHIBATA
2024-04-17Update build and install document related ↵Hiroshi SHIBATA
https://blade.ruby-lang.org/ruby-dev/39325
2024-04-07[DOC] Update PTY documentsNobuyoshi Nakada
- Fix markups as RDoc. - Remove already descriptions of removed methods.
2024-04-03YJIT: update code optimization tips in yjit.md (#10445)Maxime Chevalier-Boisvert
* YJIT: update code optimization tips in yjit.md * Function => method
2024-04-03[DOC] Fix examples for `u` packing directiveAdam Daniels
The directive is a lowercase `u` instead of an uppercase `U`. Adjusted input and output to match. Reported by Leah Neukirchen.
2024-03-31Document how to run the tests under ASAN now that they pass!KJ Tsanaktsidis
2024-03-28Use www.rfc-editor.org for RFC text.Hiroshi SHIBATA
We use the following site for that now: * https://tools.ietf.org/ or http * https://datatracker.ietf.org or http Today, IETF said the official site of RFC is www.rfc-editor.org. FYI: https://authors.ietf.org/en/references-in-rfcxml I replaced them to www.rfc-editor.org.
2024-03-27[DOC] remove repetitive words in commentscrazeteam
Signed-off-by: crazeteam <lilujing@outlook.com>
2024-03-16[ruby/irb] Fix irb_history saved to current directorytomoya ishida
(https://github.com/ruby/irb/pull/901) * Always save irb_history in HOME or XDG_CONFIG_HOME Also split irbrc search logic from irb_history search logic as a refactor * Remove IRB.conf[:RC_NAME_GENERATOR] because it's not configurable This conf is used to specify which irbrc to load. Need to configure before irbrc is loaded, so it's actually not configurable. This conf is also used for history file search, but it is configurable by conf[:HISTORY_FILE]. * remove rc_file_test because it is tested with rc_files, remove useless test setup * Make internal irbrc searching method private https://github.com/ruby/irb/commit/11d03a6ff7
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-03-14YJIT: Let yjit_perf.py support perf with Python disabled (#10246)Takashi Kokubun
* YJIT: Let yjit_perf.py support perf with Python disabled * Update yjit.md about perf * Recommend the extra interface by default
2024-03-11[DOC] security.rdoc: fix YAML security documentationAndrea Brancaleoni
Since https://github.com/ruby/ruby/commit/fbb4e3f96c10de2240f2d87eac19cf6f62f65fea `YAML` does not unmarshal arbitrary ruby objects.
2024-03-09[ruby/rdoc] [DOC] Improve documentation of include directive file searchPetrik de Heus
Searching the file in the "current directory" could be read as the directory from which RDoc is run. This is incorrect, as the file is first searched in the directory containing the current documented file. Also this directory is searched before the `--include` directories. https://github.com/ruby/rdoc/commit/aa2d98ee5e
2024-03-06[DOC] Ruby command-line options (#10138)Burdette Lamar
2024-02-27[DOC] Stop discouraging the use of Array#each (#10119)Takashi Kokubun
2024-02-26BASERUBY is now >= 3.0John Hawthorn
2024-02-23[DOC] Doc for command line options (#10059)Burdette Lamar
2024-02-21[DOC] Doc for field processing (#10008)Burdette Lamar
2024-02-15s/ therefor/therefore/ydah
2024-02-15s/ocurs/occurs/ydah
2024-02-15s/bellow/below/ydah