aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Fix language describing protected methodsJeremy Evans2022-07-141-1/+1
| | | | Fixes [Bug #18887]
* [DOC] Revisions for call-seq in doc guidelines (#6121)Burdette Lamar2022-07-121-34/+60
| | | | | | | | Splits certain guidelines for singleton and instance method. Calls for instance method to not prefix anything (like RDoc itself for a Ruby-coded instance method); e.g.: count -> integer, not array.count,. <=> other -> integer or nil, not hash <=> other -> integer or nil. Groups previous guidelines into Arguments, Block, Return types, Aliases.
* [DOC] New page for strftime formats (#6074)Burdette Lamar2022-07-011-0/+463
| | | This new page would be linked from method strftime in Time, Date, and DateTime, replacing the text there.
* Correct documentation for protected methods [ci skip]John Hawthorn2022-06-231-2/+2
|
* Added readline wrapper entries under the doc directoryHiroshi SHIBATA2022-06-212-0/+5
|
* Added error_highlight entries under the doc directoryHiroshi SHIBATA2022-06-212-0/+5
|
* Added reline entry to standard_library docHiroshi SHIBATA2022-06-211-0/+1
|
* [Feature #18788] [DOC] String options to `Regexp.new`Nobuyoshi Nakada2022-06-201-0/+5
| | | | Co-Authored-By: Janosch Müller <janosch.mueller@betterplace.org>
* [DOC] Fix markup for `String` (#5984)Alexander Ilyin2022-06-091-1/+1
| | | | | | * Add missing space for `String#start_with?`. * Add missing pluses for `String#tr` and `Methods for Converting to New String` label. * Move quote into the tag for `Whitespace in Strings` label.
* doc/case_mapping.rdoc: Fix references for case mappingYusuke Endoh2022-06-091-2/+2
| | | | | | | | The chart (https://www.unicode.org/charts/case) that is currently referred seems to be wrong. Also, use the "latest" redirect and add titles of the section and table. [Bug #18590]
* debug is the bundled gems, not default gemsHiroshi SHIBATA2022-06-061-1/+1
|
* Fix a typo [ci skip]Kazuhiro NISHIYAMA2022-06-061-1/+1
|
* Add information from doc/hacking.md and doc/make_cheatsheet.md back i… (#5963)Jemma Issroff2022-05-304-118/+105
| | | Add information from doc/hacking.md and doc/make_cheatsheet.md back into contributing docs
* Show ASAN_OPTIONS in hacking guide.Samuel Williams2022-05-271-0/+1
|
* Simplify the autoload require logic.Samuel Williams2022-05-261-0/+4
|
* Retain reference to blocking fibers.Samuel Williams2022-05-251-21/+12
|
* Add support for address sanitizer for amd64 and arm64.Samuel Williams2022-05-251-0/+115
|
* [ruby/optparse] Fix typo in documentationydah2022-05-211-2/+2
| | | | | | | - "hypnen" -> "hyphen" - "hadler" -> "handler" https://github.com/ruby/optparse/commit/e70e689ded
* [DOC] Re-markup as MarkdownNobuyoshi Nakada2022-05-191-29/+34
|
* [DOC] Use `make gdb-ruby` and `make lldb-ruby` in ↵Kaíque Kandy Koga2022-05-181-2/+2
| | | | doc/contributing/building_ruby.md
* Quick markup fixAlexey Mostovoy2022-05-121-4/+4
|
* Add a separate doc for contributing to stdlibs [ci skip]Stan Lo2022-05-113-10/+52
| | | | co-authored-by: Peter Zhu <peter@peterzhu.ca>
* Improve documentation on contributing to RubyJemma Issroff2022-05-1110-724/+438
| | | | | co-authored-by: Peter Zhu <peter@peterzhu.ca> co-authored-by: Stan Lo <stan001212@gmail.com>
* Replace with https://github.com [ci skip]Kazuhiro NISHIYAMA2022-05-072-5/+5
|
* Link from printf methods to format spec doc (#5886)Burdette Lamar2022-05-051-0/+10
|
* * remove trailing spaces. [ci skip]git2022-05-051-3/+3
|
* [DOC] More on format specs (#5877)Burdette Lamar2022-05-041-9/+151
| | | | | | * Update doc/format_specifications.rdoc Co-authored-by: Peter Zhu <peter@peterzhu.ca>
* [DOC] mention macros for public headersNobuyoshi Nakada2022-05-042-3/+23
|
* [DOC] Some YJIT dependencies are no longer requiredAlan Wu2022-05-021-3/+3
| | | | | | | The `capstone` crate on crates.io does not need `libcapstone` on the system because it builds from [source]. `gdbm` is now a separate gem (thanks for extracting it!). [source]: https://github.com/capstone-rust/capstone-rs/blob/c31409905a9fc4581133de248fcd0a66b2c37e36/capstone-sys/build.rs#L143
* [DOC] Fix links to doc pagesNobuyoshi Nakada2022-05-031-12/+12
|
* Fix a typo [ci skip]Kazuhiro NISHIYAMA2022-05-021-1/+1
|
* Repair internal links (#5866)Burdette Lamar2022-05-011-26/+26
| | | | | * Repair internal links * Minor changes to format spec
* [DOC] Format specs (#5857)Burdette Lamar2022-04-291-0/+196
| | | This new document would eventually replace the format spec discussion at Kernel#sprintf.
* Update yjit.mdMaxime Chevalier-Boisvert2022-04-271-1/+1
| | | Fix configure line in YJIT build instructions
* Rust YJITAlan Wu2022-04-271-25/+102
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In December 2021, we opened an [issue] to solicit feedback regarding the porting of the YJIT codebase from C99 to Rust. There were some reservations, but this project was given the go ahead by Ruby core developers and Matz. Since then, we have successfully completed the port of YJIT to Rust. The new Rust version of YJIT has reached parity with the C version, in that it passes all the CRuby tests, is able to run all of the YJIT benchmarks, and performs similarly to the C version (because it works the same way and largely generates the same machine code). We've even incorporated some design improvements, such as a more fine-grained constant invalidation mechanism which we expect will make a big difference in Ruby on Rails applications. Because we want to be careful, YJIT is guarded behind a configure option: ```shell ./configure --enable-yjit # Build YJIT in release mode ./configure --enable-yjit=dev # Build YJIT in dev/debug mode ``` By default, YJIT does not get compiled and cargo/rustc is not required. If YJIT is built in dev mode, then `cargo` is used to fetch development dependencies, but when building in release, `cargo` is not required, only `rustc`. At the moment YJIT requires Rust 1.60.0 or newer. The YJIT command-line options remain mostly unchanged, and more details about the build process are documented in `doc/yjit/yjit.md`. The CI tests have been updated and do not take any more resources than before. The development history of the Rust port is available at the following commit for interested parties: https://github.com/Shopify/ruby/commit/1fd9573d8b4b65219f1c2407f30a0a60e537f8be Our hope is that Rust YJIT will be compiled and included as a part of system packages and compiled binaries of the Ruby 3.2 release. We do not anticipate any major problems as Rust is well supported on every platform which YJIT supports, but to make sure that this process works smoothly, we would like to reach out to those who take care of building systems packages before the 3.2 release is shipped and resolve any issues that may come up. [issue]: https://bugs.ruby-lang.org/issues/18481 Co-authored-by: Maxime Chevalier-Boisvert <maximechevalierb@gmail.com> Co-authored-by: Noah Gibbs <the.codefolio.guy@gmail.com> Co-authored-by: Kevin Newton <kddnewton@gmail.com>
* [DOC] Change URLs from git.ioKazuhiro NISHIYAMA2022-04-271-2/+3
| | | | see https://github.blog/changelog/2022-04-25-git-io-deprecation/
* [DOC] Enhanced RDoc for Math module (#5837)Burdette Lamar2022-04-251-0/+117
| | | | | | Revises intro. Adds "What's Here". Revises methods doc.
* [DOC] mention assignment expression valuesNobuyoshi Nakada2022-04-251-0/+6
|
* More details for Rational literals (#5840)Burdette Lamar2022-04-241-7/+28
|
* [DOC] Enhanced RDoc for MatchData (#5819)Burdette Lamar2022-04-183-1/+60
| | | | | | | | Treats: #begin #end #match #match_length
* [DOC] Enhanced RDoc for MatchData (#5818)Burdette Lamar2022-04-181-0/+32
| | | | | | | | Treats: #regexp #names #size #offset
* [DOC] Enhanced RDoc for Regexp (#5812)Burdette Lamar2022-04-161-1/+9
| | | | | | | | | | | | | | | | | Treats: #fixed_encoding? #hash #== #=~ #match #match? Also, in regexp.rdoc: Changes heading from 'Special Global Variables' to 'Regexp Global Variables'. Add tiny section 'Regexp Interpolation'.
* [DOC] Enhanced RDoc for Regexp (#5807)Burdette Lamar2022-04-151-6/+6
| | | | | | | | | | | | Treats: #source #inspect #to_s #casefold? #options #names #named_captures
* [ruby/optparse] Fix broken links in docsPeter Zhu2022-04-152-3/+3
| | | | https://github.com/ruby/optparse/commit/2bea3b38c3
* More details for regexp literals (#5800)Burdette Lamar2022-04-141-12/+22
|
* Enhanced RDoc for Symbol (#5795)Burdette Lamar2022-04-122-0/+53
| | | | | | | | | | | | | | | | | | | Treats: #== #inspect #name #to_s #to_sym #to_proc #succ #<=> #casecmp #casecmp? #=~ #match #match?
* Specify which core classes are convertible (#5790)Burdette Lamar2022-04-111-0/+23
|
* All-in-one RDoc for class String (#5777)Burdette Lamar2022-04-071-138/+0
|
* Fix a typo [ci skip]Kazuhiro NISHIYAMA2022-04-071-1/+1
|
* [DOC] Enhanced RDoc for string slices (#5769)Burdette Lamar2022-04-061-0/+138
| | | Creates file doc/string/slices.rdoc that the string slicing methods can link to.
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-09 12:04:28 +0000