mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
[DOC] Replace the external URIs to docs with rdoc-ref
This commit is contained in:
Nobuyoshi Nakada
parent
2b5d4fe28d
commit
3539da64fc
7 changed files with 61 additions and 61 deletions
|
|
@ -4377,7 +4377,7 @@ date_s__strptime_internal(int argc, VALUE *argv, VALUE klass,
|
|||
* Date._strptime('2001-02-03', '%Y-%m-%d') # => {:year=>2001, :mon=>2, :mday=>3}
|
||||
*
|
||||
* For other formats, see
|
||||
* {Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html].
|
||||
* {Formats for Dates and Times}[rdoc-ref:strftime_formatting.rdoc].
|
||||
* (Unlike Date.strftime, does not support flags and width.)
|
||||
*
|
||||
* See also {strptime(3)}[https://man7.org/linux/man-pages/man3/strptime.3.html].
|
||||
|
|
@ -4406,7 +4406,7 @@ date_s__strptime(int argc, VALUE *argv, VALUE klass)
|
|||
* Date.strptime('sat3feb01', '%a%d%b%y') # => #<Date: 2001-02-03>
|
||||
*
|
||||
* For other formats, see
|
||||
* {Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html].
|
||||
* {Formats for Dates and Times}[rdoc-ref:strftime_formatting.rdoc].
|
||||
* (Unlike Date.strftime, does not support flags and width.)
|
||||
*
|
||||
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
|
||||
|
|
@ -4506,7 +4506,7 @@ date_s__parse_internal(int argc, VALUE *argv, VALUE klass)
|
|||
* This method recognizes many forms in +string+,
|
||||
* but it is not a validator.
|
||||
* For formats, see
|
||||
* {"Specialized Format Strings" in Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-Specialized+Format+Strings]
|
||||
* {"Specialized Format Strings" in Formats for Dates and Times}[rdoc-ref:strftime_formatting.rdoc@Specialized+Format+Strings]
|
||||
*
|
||||
* If +string+ does not specify a valid date,
|
||||
* the result is unpredictable;
|
||||
|
|
@ -4541,7 +4541,7 @@ date_s__parse(int argc, VALUE *argv, VALUE klass)
|
|||
* This method recognizes many forms in +string+,
|
||||
* but it is not a validator.
|
||||
* For formats, see
|
||||
* {"Specialized Format Strings" in Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-Specialized+Format+Strings]
|
||||
* {"Specialized Format Strings" in Formats for Dates and Times}[rdoc-ref:strftime_formatting.rdoc@Specialized+Format+Strings]
|
||||
* If +string+ does not specify a valid date,
|
||||
* the result is unpredictable;
|
||||
* consider using Date._strptime instead.
|
||||
|
|
@ -4606,7 +4606,7 @@ VALUE date__jisx0301(VALUE);
|
|||
* Date._iso8601(string, limit: 128) -> hash
|
||||
*
|
||||
* Returns a hash of values parsed from +string+, which should contain
|
||||
* an {ISO 8601 formatted date}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-ISO+8601+Format+Specifications]:
|
||||
* an {ISO 8601 formatted date}[rdoc-ref:strftime_formatting.rdoc@ISO+8601+Format+Specifications]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
* s = d.iso8601 # => "2001-02-03"
|
||||
|
|
@ -4633,7 +4633,7 @@ date_s__iso8601(int argc, VALUE *argv, VALUE klass)
|
|||
*
|
||||
* Returns a new \Date object with values parsed from +string+,
|
||||
* which should contain
|
||||
* an {ISO 8601 formatted date}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-ISO+8601+Format+Specifications]:
|
||||
* an {ISO 8601 formatted date}[rdoc-ref:strftime_formatting.rdoc@ISO+8601+Format+Specifications]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
* s = d.iso8601 # => "2001-02-03"
|
||||
|
|
@ -4676,7 +4676,7 @@ date_s_iso8601(int argc, VALUE *argv, VALUE klass)
|
|||
* Date._rfc3339(string, limit: 128) -> hash
|
||||
*
|
||||
* Returns a hash of values parsed from +string+, which should be a valid
|
||||
* {RFC 3339 format}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-RFC+3339+Format]:
|
||||
* {RFC 3339 format}[rdoc-ref:strftime_formatting.rdoc@RFC+3339+Format]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
* s = d.rfc3339 # => "2001-02-03T00:00:00+00:00"
|
||||
|
|
@ -4704,7 +4704,7 @@ date_s__rfc3339(int argc, VALUE *argv, VALUE klass)
|
|||
*
|
||||
* Returns a new \Date object with values parsed from +string+,
|
||||
* which should be a valid
|
||||
* {RFC 3339 format}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-RFC+3339+Format]:
|
||||
* {RFC 3339 format}[rdoc-ref:strftime_formatting.rdoc@RFC+3339+Format]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
* s = d.rfc3339 # => "2001-02-03T00:00:00+00:00"
|
||||
|
|
@ -4816,7 +4816,7 @@ date_s_xmlschema(int argc, VALUE *argv, VALUE klass)
|
|||
* Date._rfc2822(string, limit: 128) -> hash
|
||||
*
|
||||
* Returns a hash of values parsed from +string+, which should be a valid
|
||||
* {RFC 2822 date format}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-RFC+2822+Format]:
|
||||
* {RFC 2822 date format}[rdoc-ref:strftime_formatting.rdoc@RFC+2822+Format]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
* s = d.rfc2822 # => "Sat, 3 Feb 2001 00:00:00 +0000"
|
||||
|
|
@ -4846,7 +4846,7 @@ date_s__rfc2822(int argc, VALUE *argv, VALUE klass)
|
|||
*
|
||||
* Returns a new \Date object with values parsed from +string+,
|
||||
* which should be a valid
|
||||
* {RFC 2822 date format}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-RFC+2822+Format]:
|
||||
* {RFC 2822 date format}[rdoc-ref:strftime_formatting.rdoc@RFC+2822+Format]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
* s = d.rfc2822 # => "Sat, 3 Feb 2001 00:00:00 +0000"
|
||||
|
|
@ -4890,7 +4890,7 @@ date_s_rfc2822(int argc, VALUE *argv, VALUE klass)
|
|||
* Date._httpdate(string, limit: 128) -> hash
|
||||
*
|
||||
* Returns a hash of values parsed from +string+, which should be a valid
|
||||
* {HTTP date format}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-HTTP+Format]:
|
||||
* {HTTP date format}[rdoc-ref:strftime_formatting.rdoc@HTTP+Format]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
* s = d.httpdate # => "Sat, 03 Feb 2001 00:00:00 GMT"
|
||||
|
|
@ -4916,7 +4916,7 @@ date_s__httpdate(int argc, VALUE *argv, VALUE klass)
|
|||
*
|
||||
* Returns a new \Date object with values parsed from +string+,
|
||||
* which should be a valid
|
||||
* {HTTP date format}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-HTTP+Format]:
|
||||
* {HTTP date format}[rdoc-ref:strftime_formatting.rdoc@HTTP+Format]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
s = d.httpdate # => "Sat, 03 Feb 2001 00:00:00 GMT"
|
||||
|
|
@ -4958,7 +4958,7 @@ date_s_httpdate(int argc, VALUE *argv, VALUE klass)
|
|||
* Date._jisx0301(string, limit: 128) -> hash
|
||||
*
|
||||
* Returns a hash of values parsed from +string+, which should be a valid
|
||||
* {JIS X 0301 date format}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-JIS+X+0301+Format]:
|
||||
* {JIS X 0301 date format}[rdoc-ref:strftime_formatting.rdoc@JIS+X+0301+Format]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
* s = d.jisx0301 # => "H13.02.03"
|
||||
|
|
@ -4984,7 +4984,7 @@ date_s__jisx0301(int argc, VALUE *argv, VALUE klass)
|
|||
* Date.jisx0301(string = '-4712-01-01', start = Date::ITALY, limit: 128) -> date
|
||||
*
|
||||
* Returns a new \Date object with values parsed from +string+,
|
||||
* which should be a valid {JIS X 0301 format}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-JIS+X+0301+Format]:
|
||||
* which should be a valid {JIS X 0301 format}[rdoc-ref:strftime_formatting.rdoc@JIS+X+0301+Format]:
|
||||
*
|
||||
* d = Date.new(2001, 2, 3)
|
||||
* s = d.jisx0301 # => "H13.02.03"
|
||||
|
|
@ -6971,7 +6971,7 @@ static VALUE strftimev(const char *, VALUE,
|
|||
* to_s -> string
|
||||
*
|
||||
* Returns a string representation of the date in +self+
|
||||
* in {ISO 8601 extended date format}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-ISO+8601+Format+Specifications]
|
||||
* in {ISO 8601 extended date format}[rdoc-ref:strftime_formatting.rdoc@ISO+8601+Format+Specifications]
|
||||
* (<tt>'%Y-%m-%d'</tt>):
|
||||
*
|
||||
* Date.new(2001, 2, 3).to_s # => "2001-02-03"
|
||||
|
|
@ -7252,7 +7252,7 @@ date_strftime_internal(int argc, VALUE *argv, VALUE self,
|
|||
* Date.new(2001, 2, 3).strftime # => "2001-02-03"
|
||||
*
|
||||
* For other formats, see
|
||||
* {Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html].
|
||||
* {Formats for Dates and Times}[rdoc-ref:strftime_formatting.rdoc].
|
||||
*
|
||||
*/
|
||||
static VALUE
|
||||
|
|
@ -7284,7 +7284,7 @@ strftimev(const char *fmt, VALUE self,
|
|||
* asctime -> string
|
||||
*
|
||||
* Equivalent to #strftime with argument <tt>'%a %b %e %T %Y'</tt>
|
||||
* (or its {shorthand form}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-Shorthand+Conversion+Specifiers]
|
||||
* (or its {shorthand form}[rdoc-ref:strftime_formatting.rdoc@Shorthand+Conversion+Specifiers]
|
||||
* <tt>'%c'</tt>):
|
||||
*
|
||||
* Date.new(2001, 2, 3).asctime # => "Sat Feb 3 00:00:00 2001"
|
||||
|
|
@ -7304,7 +7304,7 @@ d_lite_asctime(VALUE self)
|
|||
* iso8601 -> string
|
||||
*
|
||||
* Equivalent to #strftime with argument <tt>'%Y-%m-%d'</tt>
|
||||
* (or its {shorthand form}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-Shorthand+Conversion+Specifiers]
|
||||
* (or its {shorthand form}[rdoc-ref:strftime_formatting.rdoc@Shorthand+Conversion+Specifiers]
|
||||
* <tt>'%F'</tt>);
|
||||
*
|
||||
* Date.new(2001, 2, 3).iso8601 # => "2001-02-03"
|
||||
|
|
@ -7322,7 +7322,7 @@ d_lite_iso8601(VALUE self)
|
|||
* rfc3339 -> string
|
||||
*
|
||||
* Equivalent to #strftime with argument <tt>'%FT%T%:z'</tt>;
|
||||
* see {Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html]:
|
||||
* see {Formats for Dates and Times}[rdoc-ref:strftime_formatting.rdoc]:
|
||||
*
|
||||
* Date.new(2001, 2, 3).rfc3339 # => "2001-02-03T00:00:00+00:00"
|
||||
*
|
||||
|
|
@ -7338,7 +7338,7 @@ d_lite_rfc3339(VALUE self)
|
|||
* rfc2822 -> string
|
||||
*
|
||||
* Equivalent to #strftime with argument <tt>'%a, %-d %b %Y %T %z'</tt>;
|
||||
* see {Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html]:
|
||||
* see {Formats for Dates and Times}[rdoc-ref:strftime_formatting.rdoc]:
|
||||
*
|
||||
* Date.new(2001, 2, 3).rfc2822 # => "Sat, 3 Feb 2001 00:00:00 +0000"
|
||||
*
|
||||
|
|
@ -7355,7 +7355,7 @@ d_lite_rfc2822(VALUE self)
|
|||
* httpdate -> string
|
||||
*
|
||||
* Equivalent to #strftime with argument <tt>'%a, %d %b %Y %T GMT'</tt>;
|
||||
* see {Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html]:
|
||||
* see {Formats for Dates and Times}[rdoc-ref:strftime_formatting.rdoc]:
|
||||
*
|
||||
* Date.new(2001, 2, 3).httpdate # => "Sat, 03 Feb 2001 00:00:00 GMT"
|
||||
*
|
||||
|
|
@ -9392,7 +9392,7 @@ Init_date_core(void)
|
|||
* calendar dates.
|
||||
*
|
||||
* Consider using
|
||||
* {class Time}[https://docs.ruby-lang.org/en/master/Time.html]
|
||||
* {class Time}[rdoc-ref:Time]
|
||||
* instead of class \Date if:
|
||||
*
|
||||
* - You need both dates and times; \Date handles only dates.
|
||||
|
|
@ -9444,7 +9444,7 @@ Init_date_core(void)
|
|||
* Date.strptime('fri31dec99', '%a%d%b%y') # => #<Date: 1999-12-31>
|
||||
*
|
||||
* See also the specialized methods in
|
||||
* {"Specialized Format Strings" in Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html#label-Specialized+Format+Strings]
|
||||
* {"Specialized Format Strings" in Formats for Dates and Times}[rdoc-ref:strftime_formatting.rdoc@Specialized+Format+Strings]
|
||||
*
|
||||
* == Argument +limit+
|
||||
*
|
||||
|
|
|
|||
|
|
@ -172,7 +172,7 @@ class CSV
|
|||
#
|
||||
# Raises an exception if the access mode is <tt>:row</tt>
|
||||
# and +n+ is not an
|
||||
# {Integer-convertible object}[https://docs.ruby-lang.org/en/master/implicit_conversion_rdoc.html#label-Integer-Convertible+Objects].
|
||||
# {Integer-convertible object}[rdoc-ref:implicit_conversion.rdoc@Integer-Convertible+Objects].
|
||||
# table.by_row! # => #<CSV::Table mode:row row_count:4>
|
||||
# # Raises TypeError (no implicit conversion of String into Integer):
|
||||
# table['Name']
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@ end
|
|||
#
|
||||
# First, what’s elsewhere. \Module \FileUtils:
|
||||
#
|
||||
# - Inherits from {class Object}[https://docs.ruby-lang.org/en/master/Object.html].
|
||||
# - Supplements {class File}[https://docs.ruby-lang.org/en/master/File.html]
|
||||
# - Inherits from {class Object}[rdoc-ref:Object].
|
||||
# - Supplements {class File}[rdoc-ref:File]
|
||||
# (but is not included or extended there).
|
||||
#
|
||||
# Here, module \FileUtils provides methods that are useful for:
|
||||
|
|
@ -162,8 +162,8 @@ end
|
|||
# by applying a special pre-process:
|
||||
#
|
||||
# - If the target path points to a directory, this method uses methods
|
||||
# {File#chown}[https://docs.ruby-lang.org/en/master/File.html#method-i-chown]
|
||||
# and {File#chmod}[https://docs.ruby-lang.org/en/master/File.html#method-i-chmod]
|
||||
# {File#chown}[rdoc-ref:File#chown]
|
||||
# and {File#chmod}[rdoc-ref:File#chmod]
|
||||
# in removing directories.
|
||||
# - The owner of the target directory should be either the current process
|
||||
# or the super user (root).
|
||||
|
|
@ -291,7 +291,7 @@ module FileUtils
|
|||
#
|
||||
# With no keyword arguments, creates a directory at each +path+ in +list+
|
||||
# by calling: <tt>Dir.mkdir(path, mode)</tt>;
|
||||
# see {Dir.mkdir}[https://docs.ruby-lang.org/en/master/Dir.html#method-c-mkdir]:
|
||||
# see {Dir.mkdir}[rdoc-ref:Dir.mkdir]:
|
||||
#
|
||||
# FileUtils.mkdir(%w[tmp0 tmp1]) # => ["tmp0", "tmp1"]
|
||||
# FileUtils.mkdir('tmp4') # => ["tmp4"]
|
||||
|
|
@ -299,7 +299,7 @@ module FileUtils
|
|||
# Keyword arguments:
|
||||
#
|
||||
# - <tt>mode: <i>mode</i></tt> - also calls <tt>File.chmod(mode, path)</tt>;
|
||||
# see {File.chmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-chmod].
|
||||
# see {File.chmod}[rdoc-ref:File.chmod].
|
||||
# - <tt>noop: true</tt> - does not create directories.
|
||||
# - <tt>verbose: true</tt> - prints an equivalent command:
|
||||
#
|
||||
|
|
@ -339,7 +339,7 @@ module FileUtils
|
|||
# With no keyword arguments, creates a directory at each +path+ in +list+,
|
||||
# along with any needed ancestor directories,
|
||||
# by calling: <tt>Dir.mkdir(path, mode)</tt>;
|
||||
# see {Dir.mkdir}[https://docs.ruby-lang.org/en/master/Dir.html#method-c-mkdir]:
|
||||
# see {Dir.mkdir}[rdoc-ref:Dir.mkdir]:
|
||||
#
|
||||
# FileUtils.mkdir_p(%w[tmp0/tmp1 tmp2/tmp3]) # => ["tmp0/tmp1", "tmp2/tmp3"]
|
||||
# FileUtils.mkdir_p('tmp4/tmp5') # => ["tmp4/tmp5"]
|
||||
|
|
@ -347,7 +347,7 @@ module FileUtils
|
|||
# Keyword arguments:
|
||||
#
|
||||
# - <tt>mode: <i>mode</i></tt> - also calls <tt>File.chmod(mode, path)</tt>;
|
||||
# see {File.chmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-chmod].
|
||||
# see {File.chmod}[rdoc-ref:File.chmod].
|
||||
# - <tt>noop: true</tt> - does not create directories.
|
||||
# - <tt>verbose: true</tt> - prints an equivalent command:
|
||||
#
|
||||
|
|
@ -417,7 +417,7 @@ module FileUtils
|
|||
#
|
||||
# With no keyword arguments, removes the directory at each +path+ in +list+,
|
||||
# by calling: <tt>Dir.rmdir(path)</tt>;
|
||||
# see {Dir.rmdir}[https://docs.ruby-lang.org/en/master/Dir.html#method-c-rmdir]:
|
||||
# see {Dir.rmdir}[rdoc-ref:Dir.rmdir]:
|
||||
#
|
||||
# FileUtils.rmdir(%w[tmp0/tmp1 tmp2/tmp3]) # => ["tmp0/tmp1", "tmp2/tmp3"]
|
||||
# FileUtils.rmdir('tmp4/tmp5') # => ["tmp4/tmp5"]
|
||||
|
|
@ -1044,7 +1044,7 @@ module FileUtils
|
|||
module_function :copy_file
|
||||
|
||||
# Copies \IO stream +src+ to \IO stream +dest+ via
|
||||
# {IO.copy_stream}[https://docs.ruby-lang.org/en/master/IO.html#method-c-copy_stream].
|
||||
# {IO.copy_stream}[rdoc-ref:IO.copy_stream].
|
||||
#
|
||||
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
|
||||
#
|
||||
|
|
@ -1560,14 +1560,14 @@ module FileUtils
|
|||
# Keyword arguments:
|
||||
#
|
||||
# - <tt>group: <i>group</i></tt> - changes the group if not +nil+,
|
||||
# using {File.chown}[https://docs.ruby-lang.org/en/master/File.html#method-c-chown].
|
||||
# using {File.chown}[rdoc-ref:File.chown].
|
||||
# - <tt>mode: <i>permissions</i></tt> - changes the permissions.
|
||||
# using {File.chmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-chmod].
|
||||
# using {File.chmod}[rdoc-ref:File.chmod].
|
||||
# - <tt>noop: true</tt> - does not copy entries; returns +nil+.
|
||||
# - <tt>owner: <i>owner</i></tt> - changes the owner if not +nil+,
|
||||
# using {File.chown}[https://docs.ruby-lang.org/en/master/File.html#method-c-chown].
|
||||
# using {File.chown}[rdoc-ref:File.chown].
|
||||
# - <tt>preserve: true</tt> - preserve timestamps
|
||||
# using {File.utime}[https://docs.ruby-lang.org/en/master/File.html#method-c-utime].
|
||||
# using {File.utime}[rdoc-ref:File.utime].
|
||||
# - <tt>verbose: true</tt> - prints an equivalent command:
|
||||
#
|
||||
# FileUtils.install('src0.txt', 'dest0.txt', noop: true, verbose: true)
|
||||
|
|
@ -1704,9 +1704,9 @@ module FileUtils
|
|||
# returns +list+ if it is an array, <tt>[list]</tt> otherwise:
|
||||
#
|
||||
# - Modifies each entry that is a regular file using
|
||||
# {File.chmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-chmod].
|
||||
# {File.chmod}[rdoc-ref:File.chmod].
|
||||
# - Modifies each entry that is a symbolic link using
|
||||
# {File.lchmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-lchmod].
|
||||
# {File.lchmod}[rdoc-ref:File.lchmod].
|
||||
#
|
||||
# Argument +list+ or its elements
|
||||
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
|
||||
|
|
@ -1806,9 +1806,9 @@ module FileUtils
|
|||
# returns +list+ if it is an array, <tt>[list]</tt> otherwise:
|
||||
#
|
||||
# - Modifies each entry that is a regular file using
|
||||
# {File.chown}[https://docs.ruby-lang.org/en/master/File.html#method-c-chown].
|
||||
# {File.chown}[rdoc-ref:File.chown].
|
||||
# - Modifies each entry that is a symbolic link using
|
||||
# {File.lchown}[https://docs.ruby-lang.org/en/master/File.html#method-c-lchown].
|
||||
# {File.lchown}[rdoc-ref:File.lchown].
|
||||
#
|
||||
# Argument +list+ or its elements
|
||||
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
|
||||
|
|
|
|||
|
|
@ -147,7 +147,7 @@ require_relative 'logger/errors'
|
|||
# when the entry is created.
|
||||
#
|
||||
# The logged timestamp is formatted by method
|
||||
# {Time#strftime}[https://docs.ruby-lang.org/en/master/Time.html#method-i-strftime]
|
||||
# {Time#strftime}[rdoc-ref:Time#strftime]
|
||||
# using this format string:
|
||||
#
|
||||
# '%Y-%m-%dT%H:%M:%S.%6N'
|
||||
|
|
@ -365,7 +365,7 @@ require_relative 'logger/errors'
|
|||
# You can set a different format using create-time option
|
||||
# +shift_period_suffix+;
|
||||
# see details and suggestions at
|
||||
# {Time#strftime}[https://docs.ruby-lang.org/en/master/Time.html#method-i-strftime].
|
||||
# {Time#strftime}[rdoc-ref:Time#strftime].
|
||||
#
|
||||
class Logger
|
||||
_, name, rev = %w$Id$
|
||||
|
|
@ -425,7 +425,7 @@ class Logger
|
|||
# Argument +datetime_format+ should be either of these:
|
||||
#
|
||||
# - A string suitable for use as a format for method
|
||||
# {Time#strftime}[https://docs.ruby-lang.org/en/master/Time.html#method-i-strftime].
|
||||
# {Time#strftime}[rdoc-ref:Time#strftime].
|
||||
# - +nil+: the logger uses <tt>'%Y-%m-%dT%H:%M:%S.%6N'</tt>.
|
||||
#
|
||||
def datetime_format=(datetime_format)
|
||||
|
|
@ -453,7 +453,7 @@ class Logger
|
|||
# The proc should return a string containing the formatted entry.
|
||||
#
|
||||
# This custom formatter uses
|
||||
# {String#dump}[https://docs.ruby-lang.org/en/master/String.html#method-i-dump]
|
||||
# {String#dump}[rdoc-ref:String#dump]
|
||||
# to escape the message string:
|
||||
#
|
||||
# logger = Logger.new($stdout, progname: 'mung')
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ require "digest"
|
|||
# when the store is created (see PStore.new).
|
||||
# The objects are stored and retrieved using
|
||||
# module Marshal, which means that certain objects cannot be added to the store;
|
||||
# see {Marshal::dump}[https://docs.ruby-lang.org/en/master/Marshal.html#method-c-dump].
|
||||
# see {Marshal::dump}[rdoc-ref:Marshal.dump].
|
||||
#
|
||||
# == Entries
|
||||
#
|
||||
|
|
@ -79,11 +79,11 @@ require "digest"
|
|||
# Each entry has a key and a value, just as in a hash:
|
||||
#
|
||||
# - Key: as in a hash, the key can be (almost) any object;
|
||||
# see {Hash Keys}[https://docs.ruby-lang.org/en/master/Hash.html#class-Hash-label-Hash+Keys].
|
||||
# see {Hash Keys}[rdoc-ref:Hash@Hash+Keys].
|
||||
# You may find it convenient to keep it simple by using only
|
||||
# symbols or strings as keys.
|
||||
# - Value: the value may be any object that can be marshalled by \Marshal
|
||||
# (see {Marshal::dump}[https://docs.ruby-lang.org/en/master/Marshal.html#method-c-dump])
|
||||
# (see {Marshal::dump}[rdoc-ref:Marshal.dump])
|
||||
# and in fact may be a collection
|
||||
# (e.g., an array, a hash, a set, a range, etc).
|
||||
# That collection may in turn contain nested objects,
|
||||
|
|
@ -194,7 +194,7 @@ require "digest"
|
|||
# end
|
||||
#
|
||||
# And recall that you can use
|
||||
# {dig methods}[https://docs.ruby-lang.org/en/master/dig_methods_rdoc.html]
|
||||
# {dig methods}[rdoc-ref:dig_methods.rdoc]
|
||||
# in a returned hierarchy of objects.
|
||||
#
|
||||
# == Working with the Store
|
||||
|
|
|
|||
|
|
@ -66,8 +66,8 @@
|
|||
#
|
||||
# First, what's elsewhere. \Class \Set:
|
||||
#
|
||||
# - Inherits from {class Object}[https://docs.ruby-lang.org/en/master/Object.html#class-Object-label-What-27s+Here].
|
||||
# - Includes {module Enumerable}[https://docs.ruby-lang.org/en/master/Enumerable.html#module-Enumerable-label-What-27s+Here],
|
||||
# - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
|
||||
# - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
|
||||
# which provides dozens of additional methods.
|
||||
#
|
||||
# In particular, class \Set does not have many methods of its own
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@ class Tempfile < DelegateClass(File)
|
|||
# - Directory is the system temporary directory (system-dependent).
|
||||
# - Generated filename is unique in that directory.
|
||||
# - Permissions are <tt>0600</tt>;
|
||||
# see {File Permissions}[https://docs.ruby-lang.org/en/master/File.html#label-File+Permissions].
|
||||
# see {File Permissions}[rdoc-ref:File@File+Permissions].
|
||||
# - Mode is <tt>'w+'</tt> (read/write mode, positioned at the end).
|
||||
#
|
||||
# The underlying file is removed when the \Tempfile object dies
|
||||
|
|
@ -136,12 +136,12 @@ class Tempfile < DelegateClass(File)
|
|||
# Tempfile.new('foo', '.') # => #<Tempfile:./foo20220505-17839-xfstr8>
|
||||
#
|
||||
# Keyword arguments +mode+ and +options+ are passed directly to method
|
||||
# {File.open}[https://docs.ruby-lang.org/en/master/File.html#method-c-open]:
|
||||
# {File.open}[rdoc-ref:File.open]:
|
||||
#
|
||||
# - The value given with +mode+ must be an integer,
|
||||
# and may be expressed as the logical OR of constants defined in
|
||||
# {File::Constants}[https://docs.ruby-lang.org/en/master/File/Constants.html].
|
||||
# - For +options+, see {Open Options}[https://docs.ruby-lang.org/en/master/IO.html#class-IO-label-Open+Options].
|
||||
# {File::Constants}[rdoc-ref:File::Constants].
|
||||
# - For +options+, see {Open Options}[rdoc-ref:IO@Open+Options].
|
||||
#
|
||||
# Related: Tempfile.create.
|
||||
#
|
||||
|
|
@ -344,11 +344,11 @@ end
|
|||
#
|
||||
# With no block given and no arguments, creates and returns file whose:
|
||||
#
|
||||
# - Class is {File}[https://docs.ruby-lang.org/en/master/File.html] (not \Tempfile).
|
||||
# - Class is {File}[rdoc-ref:File] (not \Tempfile).
|
||||
# - Directory is the system temporary directory (system-dependent).
|
||||
# - Generated filename is unique in that directory.
|
||||
# - Permissions are <tt>0600</tt>;
|
||||
# see {File Permissions}[https://docs.ruby-lang.org/en/master/File.html#label-File+Permissions].
|
||||
# see {File Permissions}[rdoc-ref:File@File+Permissions].
|
||||
# - Mode is <tt>'w+'</tt> (read/write mode, positioned at the end).
|
||||
#
|
||||
# With no block, the file is not removed automatically,
|
||||
|
|
@ -380,12 +380,12 @@ end
|
|||
# Tempfile.create('foo', '.') # => #<File:./foo20220505-9795-1emu6g8>
|
||||
#
|
||||
# Keyword arguments +mode+ and +options+ are passed directly to method
|
||||
# {File.open}[https://docs.ruby-lang.org/en/master/File.html#method-c-open]:
|
||||
# {File.open}[rdoc-ref:File.open]:
|
||||
#
|
||||
# - The value given with +mode+ must be an integer,
|
||||
# and may be expressed as the logical OR of constants defined in
|
||||
# {File::Constants}[https://docs.ruby-lang.org/en/master/File/Constants.html].
|
||||
# - For +options+, see {Open Options}[https://docs.ruby-lang.org/en/master/IO.html#class-IO-label-Open+Options].
|
||||
# {File::Constants}[rdoc-ref:File::Constants].
|
||||
# - For +options+, see {Open Options}[rdoc-ref:IO@Open+Options].
|
||||
#
|
||||
# With a block given, creates the file as above, passes it to the block,
|
||||
# and returns the block's value;
|
||||
|
|
|
|||
Loading…
Reference in a new issue