summaryrefslogtreecommitdiff
path: root/string.c
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2021-12-03 07:12:28 -0600
committerGitHub <noreply@github.com>2021-12-03 07:12:28 -0600
commit28fb6d6b9e06a632f96244a635a045622a6be276 (patch)
tree1c96616dc764d2b67c83fe9443b7f5ae1f8c9ea8 /string.c
parent324d57df0b28982590609d7ae080f82074a82a5c (diff)
Adding links to literals and Kernel (#5192)
* Adding links to literals and Kernel
Notes
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
Diffstat (limited to 'string.c')
-rw-r--r--string.c30
1 files changed, 21 insertions, 9 deletions
diff --git a/string.c b/string.c
index 303cd9b98b..9dcc8282c5 100644
--- a/string.c
+++ b/string.c
@@ -11152,15 +11152,18 @@ rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str)
/**********************************************************************
* Document-class: Symbol
*
- * Symbol objects represent named identifiers inside the Ruby interpreter. They
- * are generated using the <code>:name</code> and
- * <code>:"string"</code> literals syntax, and by the various
- * <code>to_sym</code> methods. The same Symbol object will be
- * created for a given name or string for the duration of a program's
- * execution, regardless of the context or meaning of that name. Thus
- * if <code>Fred</code> is a constant in one context, a method in
- * another, and a class in a third, the Symbol <code>:Fred</code>
- * will be the same object in all three contexts.
+ * Symbol objects represent named identifiers inside the Ruby interpreter.
+ *
+ * You can create a \Symbol object explicitly with:
+ *
+ * - A {symbol literal}[doc/syntax/literals_rdoc.html#label-Symbol+Literals].
+ *
+ * The same Symbol object will be
+ * created for a given name or string for the duration of a program's
+ * execution, regardless of the context or meaning of that name. Thus
+ * if <code>Fred</code> is a constant in one context, a method in
+ * another, and a class in a third, the Symbol <code>:Fred</code>
+ * will be the same object in all three contexts.
*
* module One
* class Fred
@@ -11795,6 +11798,15 @@ rb_enc_interned_str_cstr(const char *ptr, rb_encoding *enc)
* String objects differ from Symbol objects in that Symbol objects are
* designed to be used as identifiers, instead of text or data.
*
+ * You can create a \String object explicitly with:
+ *
+ * - A {string literal}[doc/syntax/literals_rdoc.html#label-String+Literals].
+ * - A {heredoc literal}[doc/syntax/literals_rdoc.html#label-Here+Document+Literals].
+ *
+ * You can convert certain objects to Strings with:
+ *
+ * - \Method {String}[Kernel.html#method-i-String].
+ *
* Some \String methods modify +self+.
* Typically, a method whose name ends with <tt>!</tt> modifies +self+
* and returns +self+;