summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* [ruby/rdoc] Mods to section Text Markup (https://github.com/ruby/rdoc/pull/916)Burdette Lamar2022-08-121-10/+16
| | | | https://github.com/ruby/rdoc/commit/5506d4d67e
* [ruby/rdoc] Improvements to Text Markup examples ↵Burdette Lamar2022-08-121-56/+48
| | | | | | (https://github.com/ruby/rdoc/pull/915) https://github.com/ruby/rdoc/commit/d00ddfe57c
* [ruby/rdoc] [DOC] Make example formats explicit and consistent ↵Burdette Lamar2022-08-111-66/+87
| | | | | | (https://github.com/ruby/rdoc/pull/913) https://github.com/ruby/rdoc/commit/7e6ef6c855
* [ruby/rdoc] Treat text markup (italic, bold, monofont) as blocks ↵Burdette Lamar2022-08-111-114/+253
| | | | | | (https://github.com/ruby/rdoc/pull/911) https://github.com/ruby/rdoc/commit/dc88f1b425
* [DOC] Adding a few standards-based formats (#6227)Burdette Lamar2022-08-101-54/+118
|
* Remove documentation about devTakashi Kokubun2022-08-081-1/+0
| | | | | | dev is Shopify's internal tool that doesn't work if you use Intel Homebrew on M1 (or rbenv, btw). Now that we maintain this outside Shopify's repository, we should stop talking about it here.
* [ruby/date] [DOC] Fix about calendars differenceNobuyoshi Nakada2022-08-081-8/+7
| | | | https://github.com/ruby/date/commit/0ae93e26aa
* [DOC] New doc about Julian/Gregorian (#70)Burdette Lamar2022-08-071-0/+63
|
* [ruby/rdoc] [DOC] Removes remaining old Markup Reference ↵Burdette Lamar2022-08-071-0/+31
| | | | | | (https://github.com/ruby/rdoc/pull/910) https://github.com/ruby/rdoc/commit/4e44c9c6cf
* [DOC] Specify ways to run bootstrap testsPeter Zhu2022-08-021-2/+3
|
* [ruby/rdoc] Add block quotes (https://github.com/ruby/rdoc/pull/907)Burdette Lamar2022-07-291-9/+57
| | | | | | Also adjusts which blocks may be nested. https://github.com/ruby/rdoc/commit/dde1860441
* [ruby/rdoc] [DOC] Add some links in intro; delimit rendered HTML output. ↵Burdette Lamar2022-07-281-54/+79
| | | | | | (https://github.com/ruby/rdoc/pull/904) https://github.com/ruby/rdoc/commit/c02645364f
* [ci-skip]Document how to run an individual bootstrap testMatt Valentine-House2022-07-271-0/+6
|
* [ruby/rdoc] [DOC] Clarifications for directives ↵Burdette Lamar2022-07-271-91/+117
| | | | | | | | | | (https://github.com/ruby/rdoc/pull/903) - Former section "Directives in Trailing Comments" is reworked. The important thing about a directive is what it does, not whether it's trailing or stand-alone. Therefore I've worked the directives in the former section into the appropriate sections, based on function. - Each directive is now explicitly marked as trailing or stand-alone. - C-code directives are mentioned only for those directives that actually appear in our ruby/ruby C files, which are :startdoc:, :stopdoc:, :enddoc:, :include:, and :call-seq:. What effect, if any, other directives have in C, I'm not sure about. https://github.com/ruby/rdoc/commit/b00978bfa5
* Add doc/rdoc directory to .documentPeter Zhu2022-07-261-0/+1
| | | | | Adding the doc/rdoc directory to .document will allow files in that directory to be included in the documentation.
* [ruby/rdoc] Move section Directives into section Blocks ↵Burdette Lamar2022-07-261-164/+162
| | | | | | (https://github.com/ruby/rdoc/pull/901) https://github.com/ruby/rdoc/commit/e48e07ef53
* * append newline at EOF. [ci skip]git2022-07-261-1/+1
|
* Sync RDocPeter Zhu2022-07-251-0/+916
|
* 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