[ruby-core:76052] [Ruby trunk Bug#12496][Third Party's Issue] [DOC] Suggestion to clear usage of String.intern
From:
nobu@...
Date:
2016-06-16 12:50:35 UTC
List:
ruby-core #76052
Issue #12496 has been updated by Nobuyoshi Nakada. Description updated Status changed from Open to Third Party's Issue In the rdoc of that method, there are both usages together. ```c /* * 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. ---------------------------------------- Bug #12496: [DOC] Suggestion to clear usage of String.intern https://bugs.ruby-lang.org/issues/12496#change-59254 * Author: Fei Song * Status: Third Party's Issue * Priority: Normal * Assignee: * ruby -v: * Backport: 2.1: UNKNOWN, 2.2: UNKNOWN, 2.3: UNKNOWN ---------------------------------------- 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? -- https://bugs.ruby-lang.org/ Unsubscribe: <mailto:ruby-core-request@ruby-lang.org?subject=unsubscribe> <http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>