Skip to content

Commit

Permalink
Fixed RDoc formatting [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
@nobu
nobu committed May 18, 2020
1 parent cf31e98 commit 185f49f
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 78 deletions.
3 changes: 1 addition & 2 deletions doc/NEWS-2.0.0
View file
Expand Up @@ -116,8 +116,7 @@ with all sufficient information, see the ChangeLog file.
corresponding method in the prepending module.
* added Module.prepended and Module.prepend_features, similar
to included and append_features.
* added Module#refine, which extends a class or module locally.
[experimental]
* added Module#refine, which extends a class or module locally. [experimental]
* extended method:
* Module#define_method accepts a UnboundMethod from a Module.
* Module#const_get accepts a qualified constant string, e.g.
Expand Down
6 changes: 2 additions & 4 deletions doc/NEWS-2.2.0
View file
Expand Up @@ -250,8 +250,7 @@ with all sufficient information, see the ChangeLog file.
* Logger::Application is extracted to logger-application gem. It's unmaintain code.

* ObjectSpace (after requiring "objspace")
* ObjectSpace.memsize_of(obj) returns a size includes sizeof(RVALUE).
[Bug #8984]
* ObjectSpace.memsize_of(obj) returns a size includes sizeof(RVALUE). [Bug #8984]

* Prime
* incompatible changes:
Expand Down Expand Up @@ -353,8 +352,7 @@ with all sufficient information, see the ChangeLog file.
* VM
* Use frozen string literals for Hash#[] and Hash#[]=
* Fast keyword arguments passing [Feature #10440]
* Allow to receive huge splatted array by a rest argument
[Feature #10440]
* Allow to receive huge splatted array by a rest argument [Feature #10440]

* Process
* Process creation methods, such as spawn(), uses vfork() system call.
Expand Down
70 changes: 25 additions & 45 deletions doc/NEWS-2.3.0
View file
Expand Up @@ -16,20 +16,19 @@ with all sufficient information, see the ChangeLog file or Redmine

* frozen-string-literal pragma:

* new pragma, frozen-string-literal has been experimentally introduced.
[Feature #8976]
* new pragma, frozen-string-literal has been experimentally introduced. [Feature #8976]
* besides, --enable/--disable=frozen-string-literal options also have
been introduced. [Feature #8976]
* command line options --debug or --debug=frozen-string-literal enable
additional debugging mode which shows created location with at frozen
object error (RuntimeError).
[Feature #11725]
object error (RuntimeError). [Feature #11725]

* safe navigation operator:

* new method call syntax, `object&.foo', method #foo is called on
`object' if it is not nil.
this is similar to `try!' in Active Support, except:
`object' if it is not nil. [Feature #11537]

This is similar to `try!' in Active Support, except:
* method name is syntactically required
obj.try! {} # valid
obj&. {} # syntax error
Expand All @@ -38,7 +37,6 @@ with all sufficient information, see the ChangeLog file or Redmine
obj&.foo(bar()) # bar() is conditionally evaluated
* attribute assignment is valid
obj&.attr += 1
[Feature #11537]

* the did_you_mean gem:

Expand All @@ -53,15 +51,13 @@ with all sufficient information, see the ChangeLog file or Redmine
* indented here document:

* new string literal, here document starts with `<<~`.
refer doc/syntax/literals.rdoc for more details.
[Feature #9098]
refer doc/syntax/literals.rdoc for more details. [Feature #9098]

=== Core classes updates (outstanding ones only)

* ARGF

* ARGF.read_nonblock supports `exception: false' like IO#read_nonblock.
[Feature #11358]
* ARGF.read_nonblock supports `exception: false' like IO#read_nonblock. [Feature #11358]

* Array

Expand All @@ -78,8 +74,7 @@ with all sufficient information, see the ChangeLog file or Redmine

* Enumerable

* Enumerable#grep_v is added as inverse version of Enumerable#grep.
[Feature #11049]
* Enumerable#grep_v is added as inverse version of Enumerable#grep. [Feature #11049]
* Enumerable#chunk_while [Feature #10769]

* Enumerator::Lazy
Expand All @@ -105,8 +100,7 @@ with all sufficient information, see the ChangeLog file or Redmine
this affect only files opened as binary. [Feature #11218]

* new option parameter `flags' is added.
this parameter is bitwise-ORed to oflags generated by normal mode argument.
[Feature #11253]
this parameter is bitwise-ORed to oflags generated by normal mode argument. [Feature #11253]

* IO#advise no longer raises Errno::ENOSYS in cases where it was
detected at build time but not available at runtime. [Feature #11806]
Expand All @@ -125,8 +119,7 @@ with all sufficient information, see the ChangeLog file or Redmine
* Numeric

* Numeric#positive? and Numeric#negative? are added, which return
true when the receiver is positive and negative respectively.
[Feature #11151]
true when the receiver is positive and negative respectively. [Feature #11151]

* Proc

Expand All @@ -152,11 +145,9 @@ with all sufficient information, see the ChangeLog file or Redmine

* String

* String#+@ and String#-@ are added to get mutable/frozen strings.
[Feature #11782]
* String#+@ and String#-@ are added to get mutable/frozen strings. [Feature #11782]

* String.new now accepts new option parameter `encoding'.
[Feature #11785]
* String.new now accepts new option parameter `encoding'. [Feature #11785]

* Struct
* Struct#dig [Feature #11688]
Expand Down Expand Up @@ -233,30 +224,26 @@ with all sufficient information, see the ChangeLog file or Redmine

* OpenSSL
* OpenSSL::SSL::SSLSocket#accept_nonblock and
OpenSSL::SSL::SSLSocket#connect_nonblock supports `exception: false`.
[Feature #10532]
OpenSSL::SSL::SSLSocket#connect_nonblock supports `exception: false`. [Feature #10532]

* Pathname
* Pathname#descend and Pathname#ascend supported blockless form.
[Feature #11052]
* Pathname#descend and Pathname#ascend supported blockless form. [Feature #11052]

* Socket
* Socket#connect_nonblock, Socket#accept_nonblock,
TCPServer#accept_nonblock, UNIXServer#accept_nonblock,
BasicSocket#recv_nonblock, BasicSocket#recvmsg_nonblock,
BasicSocket#sendmsg_nonblock all support `exception: false` to return
:wait_readable or :wait_writable symbols instead of raising
IO::WaitReadable or IO::WaitWritable exceptions
[Feature #10532] [Feature #11229]
IO::WaitReadable or IO::WaitWritable exceptions [Feature #10532] [Feature #11229]
* BasicSocket#recv and BasicSocket#recv_nonblock allow an output
String buffer argument like IO#read and IO#read_nonblock to reduce
GC overhead [Feature #11242]

* StringIO
* In read-only mode, StringIO#set_encoding no longer sets the encoding
of its buffer string. Setting the encoding of the string directly
without StringIO#set_encoding may cause unpredictable behavior now.
[Bug #11827]
without StringIO#set_encoding may cause unpredictable behavior now. [Bug #11827]

* timeout
* Object#timeout is now warned as deprecated when called.
Expand Down Expand Up @@ -297,8 +284,7 @@ with all sufficient information, see the ChangeLog file or Redmine
* default value of Net::HTTP#open_timeout is now 60 (was nil).

* Net::Telnet
* Net::Telnet is extracted to net-telnet gem. It's unmaintain code.
[Feature #11083]
* Net::Telnet is extracted to net-telnet gem. It's unmaintain code. [Feature #11083]

* Psych
* Updated to Psych 2.0.17
Expand Down Expand Up @@ -330,8 +316,7 @@ with all sufficient information, see the ChangeLog file or Redmine
class is already defined but its superclass does not match the given
superclass, as well as definitions in ruby level.

* rb_timespec_now() is added to fetch current datetime as struct timespec.
[Feature #11558]
* rb_timespec_now() is added to fetch current datetime as struct timespec. [Feature #11558]

* rb_time_timespec_new() is added to create a time object with epoch,
nanosecond, and UTC/localtime/time offset arguments. [Feature #11558]
Expand All @@ -354,11 +339,9 @@ with all sufficient information, see the ChangeLog file or Redmine

=== Implementation improvements

* Optimize Proc#call to eliminate method frame construction.
[Feature #11569]
* Optimize Proc#call to eliminate method frame construction. [Feature #11569]

* Reconsidering method entry data structure.
[Bug #11278]
* Reconsidering method entry data structure. [Bug #11278]

* Introducing new table data structure for ID keys tables used by
method table and so on. New table structure is simple and fast
Expand All @@ -367,13 +350,11 @@ with all sufficient information, see the ChangeLog file or Redmine
* Machine code level tuning for object allocation and method calling
code. r52099, r52254

* RubyVM::InstructionSequence is extended for future improvement.
[Feature #11788]
* RubyVM::InstructionSequence is extended for future improvement. [Feature #11788]

* Case dispatch is now optimized for all special constant literals
including nil, true, and false. Previously, only literal strings,
symbols, integers and floats compiled to optimized case dispatch.
[Feature #11769]
symbols, integers and floats compiled to optimized case dispatch. [Feature #11769]

* Instance variables on non-pure Ruby classes (T_DATA, T_FILE,
etc..) is less expensive to store than before. [Feature #11170]
Expand All @@ -382,8 +363,7 @@ with all sufficient information, see the ChangeLog file or Redmine
constant-time. Previously, Struct elements beyond the first 10
elements used a linear scan. [Feature #10585]

* The Set class got several speed up.
[Misc #10754], [r52591]
* The Set class got several speed up. [Misc #10754], [r52591]

* Socket and I/O-related improvements

Expand All @@ -397,8 +377,8 @@ with all sufficient information, see the ChangeLog file or Redmine
addition to reducing expensive exceptions. [Feature #11044]

* (Linux-only) waiting on a single FD anywhere in the stdlib no longer
uses select(2), making it immune to slowdowns with high-numbered FDs.
[Feature #11081] [Feature #11377]
uses select(2), making it immune to slowdowns with high-numbered
FDs. [Feature #11081] [Feature #11377]

* CGI.escapeHTML is optimized with C extension.
https://github.com/ruby/ruby/pull/1164

0 comments on commit 185f49f

Please sign in to comment.