Bug #12496: [DOC] Suggestion to clear usage of String.intern

• Status: Third Party's Issue
• Assignee: -
• Target version: -
• Backport: 2.1: UNKNOWN, 2.2: UNKNOWN, 2.3: UNKNOWN

[southwolf (Fei Song)]

The usage notes of String#intern
http://ruby-doc.org/core-2.3.1/String.html#method-i-intern

is exactly a copy of String.to_sym

http://ruby-doc.org/core-2.3.1/String.html#method-i-to_sym

which might cause confusion.

Which is a better solution, tell users they are almost same, or explain each method individually?

[nobu (Nobuyoshi Nakada)]

• Description updated (diff)
• Status changed from Open to Third Party's Issue

In the rdoc of that method, there are both usages together.

/*
 *  call-seq:
 *     str.intern   -> symbol
 *     str.to_sym   -> symbol

RDoc separates it for some reasons.

I think it would be better that same methods have references to each other.