1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Small fixes for documentation rendering

Browse Source 
Mostly just fixing RDoc's incorrect treatment of `+`
This commit is contained in:
Victor Shepelev 2023-12-09 06:54:33 +02:00 committed by GitHub
parent 1cbe114d1c
commit 07734b51c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
cont.c
View File

@ -3272,18 +3272,18 @@ rb_fiber_m_raise(int argc, VALUE *argv, VALUE self)
* call-seq: * call-seq:
* fiber.kill -> nil * fiber.kill -> nil
* *
* Terminates +fiber+ by raising an uncatchable exception. * Terminates the fiber by raising an uncatchable exception.
* It only terminates the given Fiber and no other Fiber, returning +nil+ to * It only terminates the given fiber and no other fiber, returning +nil+ to
* another Fiber if that Fiber was calling +fiber.resume+ or +fiber.transfer+. * another fiber if that fiber was calling #resume or #transfer.
* *
* +Fiber#kill+ only interrupts another Fiber when it is in +Fiber.yield+. * <tt>Fiber#kill</tt> only interrupts another fiber when it is in Fiber.yield.
* If called on the current Fiber then it raises that exception at the +Fiber#kill+ call site. * If called on the current fiber then it raises that exception at the <tt>Fiber#kill</tt> call site.
* *
* If the fiber has not been started, transition directly to the terminated state. * If the fiber has not been started, transition directly to the terminated state.
* *
* If the fiber is already terminated, does nothing. * If the fiber is already terminated, does nothing.
* *
* Raises +FiberError+ if called on a Fiber belonging to another +Thread+. * Raises FiberError if called on a fiber belonging to another thread.
*/ */
static VALUE static VALUE
rb_fiber_m_kill(VALUE self) rb_fiber_m_kill(VALUE self)

2
dir.c
View File

@ -1322,7 +1322,7 @@ dir_s_fchdir(VALUE klass, VALUE fd_value)
* Dir.pwd # => "/" * Dir.pwd # => "/"
* dir = Dir.new('example') * dir = Dir.new('example')
* dir.chdir * dir.chdir
* dir.pwd # => "/example" * Dir.pwd # => "/example"
* *
*/ */
static VALUE static VALUE

8
error.c
View File

@ -291,11 +291,11 @@ rb_warning_s_warn(int argc, VALUE *argv, VALUE mod)
* *
* Changing the behavior of Warning.warn is useful to customize how warnings are * Changing the behavior of Warning.warn is useful to customize how warnings are
* handled by Ruby, for instance by filtering some warnings, and/or outputting * handled by Ruby, for instance by filtering some warnings, and/or outputting
* warnings somewhere other than $stderr. * warnings somewhere other than <tt>$stderr</tt>.
* *
* If you want to change the behavior of Warning.warn you should use * If you want to change the behavior of Warning.warn you should use
* +Warning.extend(MyNewModuleWithWarnMethod)+ and you can use `super` * <tt>Warning.extend(MyNewModuleWithWarnMethod)</tt> and you can use +super+
* to get the default behavior of printing the warning to $stderr. * to get the default behavior of printing the warning to <tt>$stderr</tt>.
* *
* Example: * Example:
* module MyWarningFilter * module MyWarningFilter
@ -312,7 +312,7 @@ rb_warning_s_warn(int argc, VALUE *argv, VALUE mod)
* You should never redefine Warning#warn (the instance method), as that will * You should never redefine Warning#warn (the instance method), as that will
* then no longer provide a way to use the default behavior. * then no longer provide a way to use the default behavior.
* *
* The +warning+ gem provides convenient ways to customize Warning.warn. * The warning[https://rubygems.org/gems/warning] gem provides convenient ways to customize Warning.warn.
*/ */
static VALUE static VALUE

14
range.c
View File

@ -2394,14 +2394,14 @@ empty_region_p(VALUE beg, VALUE end, int excl)
* This method assumes that there is no minimum value because * This method assumes that there is no minimum value because
* Ruby lacks a standard method for determining minimum values. * Ruby lacks a standard method for determining minimum values.
* This assumption is invalid. * This assumption is invalid.
* For example, there is no value smaller than +-Float::INFINITY+, * For example, there is no value smaller than <tt>-Float::INFINITY</tt>,
* making +(...-Float::INFINITY)+ an empty set. * making <tt>(...-Float::INFINITY)</tt> an empty set.
* Consequently, +(...-Float::INFINITY)+ has no elements in common with itself, * Consequently, <tt>(...-Float::INFINITY)</tt> has no elements in common with itself,
* yet +(...-Float::INFINITY).overlap?((...-Float::INFINITY))+ returns * yet <tt>(...-Float::INFINITY).overlap?((...-Float::INFINITY))<tt> returns
* true due to this assumption. * +true+ due to this assumption.
* In general, if +r = (...minimum); r.overlap?(r)+ returns +true+, * In general, if <tt>r = (...minimum); r.overlap?(r)</tt> returns +true+,
* where +minimum+ is a value that no value is smaller than. * where +minimum+ is a value that no value is smaller than.
* Such values include +-Float::INFINITY+, +[]+, +""+, and * Such values include <tt>-Float::INFINITY</tt>, <tt>[]</tt>, <tt>""</tt>, and
* classes without subclasses. * classes without subclasses.
* *
* Related: Range#cover?. * Related: Range#cover?.