diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing/documentation_guide.md | 2 | ||||
| -rw-r--r-- | doc/encodings.rdoc | 2 | ||||
| -rw-r--r-- | doc/maintainers.md | 2 | ||||
| -rw-r--r-- | doc/marshal.rdoc | 4 | ||||
| -rw-r--r-- | doc/math/math.rdoc | 2 |
5 files changed, 6 insertions, 6 deletions
diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md index a4df55e244..7971fc16e9 100644 --- a/doc/contributing/documentation_guide.md +++ b/doc/contributing/documentation_guide.md @@ -202,7 +202,7 @@ However, _do_ suppress auto-linking when the word in question does not refer to a Ruby entity (e.g., some uses of _Class_ or _English_): ```rdoc -\Class variables can be tricky. +Class variables can be tricky. ``` renders as: diff --git a/doc/encodings.rdoc b/doc/encodings.rdoc index e563aad296..7ec097c516 100644 --- a/doc/encodings.rdoc +++ b/doc/encodings.rdoc @@ -30,7 +30,7 @@ Other characters, such as the Euro symbol, are multi-byte: s = "\u20ac" # => "€" s.bytes # => [226, 130, 172] -== The \Encoding \Class +== The \Encoding Class === \Encoding Objects diff --git a/doc/maintainers.md b/doc/maintainers.md index a1ab8cf855..15dbafbe73 100644 --- a/doc/maintainers.md +++ b/doc/maintainers.md @@ -9,7 +9,7 @@ and publishing Ruby patch releases. [The list of current branch maintainers is available in the wiki](https://github.com/ruby/ruby/wiki/Release-Engineering). -## \Module Maintainers +## Module Maintainers A module maintainer is responsible for a certain part of Ruby. diff --git a/doc/marshal.rdoc b/doc/marshal.rdoc index abf9467262..b60286a396 100644 --- a/doc/marshal.rdoc +++ b/doc/marshal.rdoc @@ -188,9 +188,9 @@ bytes: result += (byte * 2 ** (exp * 8)) end -=== Class and Module +=== +Class+ and +Module+ -"c" represents a Class object, "m" represents a Module and "M" represents +"c" represents a +Class+ object, "m" represents a +Module+ and "M" represents either a class or module (this is an old-style for compatibility). No class or module content is included, this type is only a reference. Following the type byte is a byte sequence which is used to look up an existing class or diff --git a/doc/math/math.rdoc b/doc/math/math.rdoc index 7a89df951c..2978375564 100644 --- a/doc/math/math.rdoc +++ b/doc/math/math.rdoc @@ -1,4 +1,4 @@ -\Module \Math provides methods for basic trigonometric, +Module \Math provides methods for basic trigonometric, logarithmic, and transcendental functions, and for extracting roots. You can write its constants and method calls thus: |