[DOC] Make example formats explicit and consistent #913
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BurdetteLamar
changed the title
peterzhu2118
reviewed
Aug 8, 2022
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Aug 11, 2022
maximecb
added a commit
to Shopify/ruby
that referenced
this pull request
Aug 11, 2022
* Only allow procs created by Symbol#to_proc to call public methods
Fixes [Bug #18826]
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
* Revert "Add {Method,UnboundMethod}#{public?,private?,protected?}"
This reverts commit 2727815 and
58dc8bf.
Visibility is an attribute of the method entry in a class, not an
attribute of the Method object.
Fixes [#18729]
Fixes [#18751]
Fixes [#18435]
* [ruby/rdoc] Treat text markup (italic, bold, monofont) as blocks (ruby/rdoc#911)
ruby/rdoc@dc88f1b425
* Add `--enable-devel` configure option
Since `RUBY_DEVEL` in cppflags has no effect in the configure script
and makefiles.
* Fix paths of exts.mk to clean
exts.mk files are one level under the top of extension directories.
* The "gems" build directory was rename as ".bundle"
* Fix race conditions when cleaning extensions
Clean built directories by `make distclean`, and then clean leftover
makefiles for skipped extensions.
* Fix Array#[] with ArithmeticSequence with negative steps (ruby#5739)
* Fix Array#[] with ArithmeticSequence with negative steps
Previously, Array#[] when called with an ArithmeticSequence
with a negative step did not handle all cases correctly,
especially cases involving infinite ranges, inverted ranges,
and/or exclusive ends.
Fixes [Bug #18247]
* Add Array#slice tests for ArithmeticSequence with negative step to test_array
Add tests of rb_arithmetic_sequence_beg_len_step C-API function.
* Fix ext/-test-/arith_seq/beg_len_step/depend
* Rename local variables
* Fix a variable name
Co-authored-by: Kenta Murata <3959+mrkn@users.noreply.github.com>
* [ruby/rdoc] [DOC] Make example formats explicit and consistent (ruby/rdoc#913)
ruby/rdoc@7e6ef6c855
* Fix inspect for unicode codepoint 0x85
This is an inelegant hack, by manually checking for this specific
code point in rb_str_inspect. Some testing indicates that this is
the only code point affected.
It's possible a better fix would be inside of lower-level encoding
code, such that rb_enc_isprint would return false and not true for
codepoint 0x85.
Fixes [Bug #16842]
* * 2022-08-12 [ci skip]
* [ruby/rdoc] Improvements to Text Markup examples (ruby/rdoc#915)
ruby/rdoc@d00ddfe57c
Co-authored-by: Jeremy Evans <code@jeremyevans.net>
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com>
Co-authored-by: Kenta Murata <3959+mrkn@users.noreply.github.com>
Co-authored-by: git <svn-admin@ruby-lang.org>
maximecb
added a commit
to Shopify/ruby
that referenced
this pull request
Aug 16, 2022
* Only allow procs created by Symbol#to_proc to call public methods
Fixes [Bug #18826]
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
* Revert "Add {Method,UnboundMethod}#{public?,private?,protected?}"
This reverts commit 2727815 and
58dc8bf.
Visibility is an attribute of the method entry in a class, not an
attribute of the Method object.
Fixes [#18729]
Fixes [#18751]
Fixes [#18435]
* [ruby/rdoc] Treat text markup (italic, bold, monofont) as blocks (ruby/rdoc#911)
ruby/rdoc@dc88f1b425
* Add `--enable-devel` configure option
Since `RUBY_DEVEL` in cppflags has no effect in the configure script
and makefiles.
* Fix paths of exts.mk to clean
exts.mk files are one level under the top of extension directories.
* The "gems" build directory was rename as ".bundle"
* Fix race conditions when cleaning extensions
Clean built directories by `make distclean`, and then clean leftover
makefiles for skipped extensions.
* Fix Array#[] with ArithmeticSequence with negative steps (ruby#5739)
* Fix Array#[] with ArithmeticSequence with negative steps
Previously, Array#[] when called with an ArithmeticSequence
with a negative step did not handle all cases correctly,
especially cases involving infinite ranges, inverted ranges,
and/or exclusive ends.
Fixes [Bug #18247]
* Add Array#slice tests for ArithmeticSequence with negative step to test_array
Add tests of rb_arithmetic_sequence_beg_len_step C-API function.
* Fix ext/-test-/arith_seq/beg_len_step/depend
* Rename local variables
* Fix a variable name
Co-authored-by: Kenta Murata <3959+mrkn@users.noreply.github.com>
* [ruby/rdoc] [DOC] Make example formats explicit and consistent (ruby/rdoc#913)
ruby/rdoc@7e6ef6c855
* Fix inspect for unicode codepoint 0x85
This is an inelegant hack, by manually checking for this specific
code point in rb_str_inspect. Some testing indicates that this is
the only code point affected.
It's possible a better fix would be inside of lower-level encoding
code, such that rb_enc_isprint would return false and not true for
codepoint 0x85.
Fixes [Bug #16842]
* * 2022-08-12 [ci skip]
* [ruby/rdoc] Improvements to Text Markup examples (ruby/rdoc#915)
ruby/rdoc@d00ddfe57c
* [ruby/rdoc] Mods to section Text Markup (ruby/rdoc#916)
ruby/rdoc@5506d4d67e
* [ruby/error_highlight] Add a note about the current limitation of ErrorHighlight.spot
ruby/error_highlight@489ce80a62
* All extensions in bundled gems are built by build-ext now
`RbInstall::GemInstaller#build_extensions` has nothing to do.
* No bundled gems to be installed from gem now
* [DOC] Use `true`/`false` for `@retval`s which are `bool`
* Add missing `rb_enc_iscntrl`
* Stop defining `RUBY_ABI_VERSION` if released versions
As commented in include/ruby/internal/abi.h, since teeny versions of
Ruby should guarantee ABI compatibility, `RUBY_ABI_VERSION` has no role
in released versions of Ruby.
* Add Numeric#ceildiv and Integer#ceildiv
* Remove Numeric#ceildiv
* Improve performance of Integer#ceildiv
This patch is suggested by nobu.
Benchmark result:
```
require 'benchmark'
n = 10 ** 7
Benchmark.bm do |x|
x.report("Fixnum/Fixnum") { a, b = 5, 2; n.times { a.ceildiv(b) } }
x.report("Bignum/Bignum") { a, b = 10**100, 10**99 - 1; n.times { a.ceildiv(b) } }
x.report("Bignum/Fixnum") { a, b = 10**100, 3; n.times { a.ceildiv(b) } }
end
```
Original:
```
user system total real
Fixnum/Fixnum 3.340009 0.043029 3.383038 ( 3.384022)
Bignum/Bignum 8.229500 0.118543 8.348043 ( 8.349574)
Bignum/Fixnum 8.328971 0.097842 8.426813 ( 8.426952)
```
Improved:
```
user system total real
Fixnum/Fixnum 0.699140 0.000961 0.700101 ( 0.700199)
Bignum/Bignum 5.076165 0.083160 5.159325 ( 5.159360)
Bignum/Fixnum 5.548684 0.115372 5.664056 ( 5.666735)
```
* [Bug #18962] Do not read again once reached EOF
`Ripper::Lexer#parse` re-parses the source code with syntax errors
when `raise_errors: false`.
Co-Authored-By: tompng <tomoyapenguin@gmail.com>
* Short-circuit `Process._fork`
* Introduce with_warn_vsprintf macro
* Bundle unreleased debug
* Preserve each column positions in gems/bundled_gems
* Adjust columns in gems/bundled_gems [ci skip]
* [ruby/rdoc] [DOC] Enhances text about escapes (ruby/rdoc#917)
ruby/rdoc@c40bac829c
* * 2022-08-13 [ci skip]
* Add a NEWS entry about Integer#ceildiv [ci skip]
* [DOC] Add the link to [Feature #18809]
* Silent configure does not output cached configurations
* * 2022-08-14 [ci skip]
* Update dependencies
* [ruby/rinda] Handle situations where IPv4 multicast is not available
Fixes [Bug #13864]
ruby/rinda@3cd620f38c
* * 2022-08-15 [ci skip]
* [rubygems/rubygems] Fix Ruby platform incorrectly removed on `bundle update`
rubygems/rubygems@0d321c9e3a
* [ruby/date] [DOC] Enhanced intro for Date (ruby/date#72)
ruby/date@59a6673221
* Add test for GC thrashing of young object creation
This test will prevent performance regressions like [Bug #18929].
* Simplify around `USE_YJIT` macro (ruby#6240)
* Simplify around `USE_YJIT` macro
- Use `USE_YJIT` macro only instead of `YJIT_BUILD`.
- An intermediate macro `YJIT_SUPPORTED_P` is no longer used.
* Bail out if YJIT is enabled on unsupported platforms
* * 2022-08-16 [ci skip]
* [ruby/rdoc] [DOC] Remove duplicated line in RDoc::MarkupReference
ruby/rdoc@488f89aee4
* Allow aarch64 to build YJIT
Co-authored-by: Jeremy Evans <code@jeremyevans.net>
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com>
Co-authored-by: Kenta Murata <3959+mrkn@users.noreply.github.com>
Co-authored-by: git <svn-admin@ruby-lang.org>
Co-authored-by: Yusuke Endoh <mame@ruby-lang.org>
Co-authored-by: Kouhei Yanagita <yanagi@shakenbu.org>
Co-authored-by: tompng <tomoyapenguin@gmail.com>
Co-authored-by: S-H-GAMELINKS <gamelinks007@gmail.com>
Co-authored-by: David Rodríguez <deivid.rodriguez@riseup.net>
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
Co-authored-by: Takashi Kokubun <takashikkbn@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#or/* ... */).#from most examples.