Typofix under doc directory
This commit is contained in:
parent
70618a48f7
commit
c903cddf55
@ -10,7 +10,7 @@ Just a list of acronyms I've run across in the Ruby source code and their meanin
|
|||||||
| `cd` | Call Data. A data structure that points at the `ci` and the `cc`. `iseq` objects points at the `cd`, and access call information and call caches via this structure |
|
| `cd` | Call Data. A data structure that points at the `ci` and the `cc`. `iseq` objects points at the `cd`, and access call information and call caches via this structure |
|
||||||
| `cfp`| Control Frame Pointer. Represents a Ruby stack frame. Calling a method pushes a new frame (cfp), returning pops a frame. Points at the `pc`, `sp`, `ep`, and the corresponding `iseq`|
|
| `cfp`| Control Frame Pointer. Represents a Ruby stack frame. Calling a method pushes a new frame (cfp), returning pops a frame. Points at the `pc`, `sp`, `ep`, and the corresponding `iseq`|
|
||||||
| `ci` | Call Information. Refers to an `rb_callinfo` struct. Contains call information about the call site, including number of parameters to be passed, whether it they are keyword arguments or not, etc. Used in conjunction with the `cc` and `cd`. |
|
| `ci` | Call Information. Refers to an `rb_callinfo` struct. Contains call information about the call site, including number of parameters to be passed, whether it they are keyword arguments or not, etc. Used in conjunction with the `cc` and `cd`. |
|
||||||
| `cref` | Class reference. A structure pointing to the class reference where `klass_or_self`, visibility scope, and refinements are stored. It also stores a pointer to the next class in the hierachy referenced by `rb_cref_struct * next`. The Class reference is lexically scoped. |
|
| `cref` | Class reference. A structure pointing to the class reference where `klass_or_self`, visibility scope, and refinements are stored. It also stores a pointer to the next class in the hierarchy referenced by `rb_cref_struct * next`. The Class reference is lexically scoped. |
|
||||||
| CRuby | Implementation of Ruby written in C |
|
| CRuby | Implementation of Ruby written in C |
|
||||||
| `cvar` | Class Variable. Refers to a Ruby class variable like `@@foo` |
|
| `cvar` | Class Variable. Refers to a Ruby class variable like `@@foo` |
|
||||||
| `dvar` | Dynamic Variable. Used by the parser to refer to local variables that are defined outside of the current lexical scope. For example `def foo; bar = 1; -> { p bar }; end` the "bar" inside the block is a `dvar` |
|
| `dvar` | Dynamic Variable. Used by the parser to refer to local variables that are defined outside of the current lexical scope. For example `def foo; bar = 1; -> { p bar }; end` the "bar" inside the block is a `dvar` |
|
||||||
|
@ -307,7 +307,7 @@ The standard error stream (the default value for <tt>$stderr</tt>):
|
|||||||
|
|
||||||
STDERR # => #<IO:<STDERR>>
|
STDERR # => #<IO:<STDERR>>
|
||||||
|
|
||||||
== Enviroment
|
== Environment
|
||||||
|
|
||||||
=== ENV
|
=== ENV
|
||||||
|
|
||||||
|
@ -437,7 +437,7 @@ Executions:
|
|||||||
adipiscing elit. Aenean commodo ligula eget.
|
adipiscing elit. Aenean commodo ligula eget.
|
||||||
Aenean massa. Cum sociis natoque penatibus
|
Aenean massa. Cum sociis natoque penatibus
|
||||||
et magnis dis parturient montes, nascetur
|
et magnis dis parturient montes, nascetur
|
||||||
ridiculus mus. Donec quam felis, ultricies
|
ridiculous mus. Donec quam felis, ultricies
|
||||||
nec, pellentesque eu, pretium quis, sem.
|
nec, pellentesque eu, pretium quis, sem.
|
||||||
$ ruby descriptions.rb --xxx
|
$ ruby descriptions.rb --xxx
|
||||||
["--xxx", true]
|
["--xxx", true]
|
||||||
|
@ -5,7 +5,7 @@ Lorem ipsum dolor sit amet, consectetuer
|
|||||||
adipiscing elit. Aenean commodo ligula eget.
|
adipiscing elit. Aenean commodo ligula eget.
|
||||||
Aenean massa. Cum sociis natoque penatibus
|
Aenean massa. Cum sociis natoque penatibus
|
||||||
et magnis dis parturient montes, nascetur
|
et magnis dis parturient montes, nascetur
|
||||||
ridiculus mus. Donec quam felis, ultricies
|
ridiculous mus. Donec quam felis, ultricies
|
||||||
nec, pellentesque eu, pretium quis, sem.
|
nec, pellentesque eu, pretium quis, sem.
|
||||||
EOT
|
EOT
|
||||||
descriptions = description.split($/)
|
descriptions = description.split($/)
|
||||||
|
@ -570,7 +570,7 @@ Execution:
|
|||||||
Aenean massa. Cum sociis natoque penatibus
|
Aenean massa. Cum sociis natoque penatibus
|
||||||
-y, --yyy YYY Lorem ipsum dolor sit amet, consectetuer.
|
-y, --yyy YYY Lorem ipsum dolor sit amet, consectetuer.
|
||||||
-z, --zzz [ZZZ] Et magnis dis parturient montes, nascetur
|
-z, --zzz [ZZZ] Et magnis dis parturient montes, nascetur
|
||||||
ridiculus mus. Donec quam felis, ultricies
|
ridiculous mus. Donec quam felis, ultricies
|
||||||
nec, pellentesque eu, pretium quis, sem.
|
nec, pellentesque eu, pretium quis, sem.
|
||||||
|
|
||||||
The program name is included in the default banner:
|
The program name is included in the default banner:
|
||||||
@ -609,7 +609,7 @@ Execution:
|
|||||||
Aenean massa. Cum sociis natoque penatibus
|
Aenean massa. Cum sociis natoque penatibus
|
||||||
-y, --yyy YYY Lorem ipsum dolor sit amet, consectetuer.
|
-y, --yyy YYY Lorem ipsum dolor sit amet, consectetuer.
|
||||||
-z, --zzz [ZZZ] Et magnis dis parturient montes, nascetur
|
-z, --zzz [ZZZ] Et magnis dis parturient montes, nascetur
|
||||||
ridiculus mus. Donec quam felis, ultricies
|
ridiculous mus. Donec quam felis, ultricies
|
||||||
nec, pellentesque eu, pretium quis, sem.
|
nec, pellentesque eu, pretium quis, sem.
|
||||||
|
|
||||||
=== Top List and Base List
|
=== Top List and Base List
|
||||||
|
@ -1216,13 +1216,13 @@ require 'rdoc'
|
|||||||
#
|
#
|
||||||
class RDoc::MarkupReference
|
class RDoc::MarkupReference
|
||||||
|
|
||||||
# exmaple class
|
# example class
|
||||||
class DummyClass; end
|
class DummyClass; end
|
||||||
|
|
||||||
# exmaple module
|
# example module
|
||||||
module DummyModule; end
|
module DummyModule; end
|
||||||
|
|
||||||
# exmaple singleton method
|
# example singleton method
|
||||||
def self.dummy_singleton_method(foo, bar); end
|
def self.dummy_singleton_method(foo, bar); end
|
||||||
|
|
||||||
# example instance method
|
# example instance method
|
||||||
@ -1230,12 +1230,12 @@ class RDoc::MarkupReference
|
|||||||
|
|
||||||
alias dummy_instance_alias dummy_instance_method
|
alias dummy_instance_alias dummy_instance_method
|
||||||
|
|
||||||
# exmaple attribute
|
# example attribute
|
||||||
attr_accessor :dummy_attribute
|
attr_accessor :dummy_attribute
|
||||||
|
|
||||||
alias dummy_attribute_alias dummy_attribute
|
alias dummy_attribute_alias dummy_attribute
|
||||||
|
|
||||||
# exmaple constant
|
# example constant
|
||||||
DUMMY_CONSTANT = ''
|
DUMMY_CONSTANT = ''
|
||||||
|
|
||||||
# :call-seq:
|
# :call-seq:
|
||||||
|
@ -47,9 +47,9 @@ of the operation.
|
|||||||
=== <code>&&</code>, <code>and</code>
|
=== <code>&&</code>, <code>and</code>
|
||||||
|
|
||||||
Both <code>&&</code>/<code>and</code> operators provide short-circuiting by executing each
|
Both <code>&&</code>/<code>and</code> operators provide short-circuiting by executing each
|
||||||
side of the operator, left to right, and stopping at the first occurence of a
|
side of the operator, left to right, and stopping at the first occurrence of a
|
||||||
falsey expression. The expression that defines the result is the last one
|
falsey expression. The expression that defines the result is the last one
|
||||||
executed, whether it be the final expression, or the first occurence of a falsey
|
executed, whether it be the final expression, or the first occurrence of a falsey
|
||||||
expression.
|
expression.
|
||||||
|
|
||||||
Some examples:
|
Some examples:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user