[ruby-core:68939] [Ruby trunk - Bug #11078] [Open] 2.2 String#unicode_normalize method does not appear in generated API docs

From: jonathan@...
Date: 2015-04-20 14:39:55 UTC
List: ruby-core #68939
Issue #11078 has been reported by jonathan rochkind.

----------------------------------------
Bug #11078: 2.2 String#unicode_normalize method does not appear in generated API docs
https://bugs.ruby-lang.org/issues/11078

* Author: jonathan rochkind
* Status: Open
* Priority: Normal
* Assignee: 
* ruby -v: ruby 2.2.1p85 (2015-02-26 revision 49769) [x86_64-darwin12.0]
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN
----------------------------------------
The new in 2.2 String#unicode_normalize and String#unicode_normalized? methods are very useful. 

But they do not seem to appear in the generated ruby API docs, which means many people won't realize they exist. 

http://ruby-doc.org/core-2.2.0/String.html

Does not mention any `unicode_normalize` method. Should it?  

There is generated docs for a UnicodeNormalize module at http://ruby-doc.org/stdlib-2.2.0/libdoc/unicode_normalize/rdoc/UnicodeNormalize.html , but it documents methods with different names, just `normalize` and `normalized?`.  I think these are the same methods. I am not sure if this module is what is used in String? I am not sure why the method names differ, or why they don't show up directly in the generated String API docs. 

If they could show up in the generated String API docs, with the correct method names, it would make it easier for developers to discover their existence and proper method names and functionality. 





-- 
https://bugs.ruby-lang.org/

In This Thread

Prev Next