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

Issue #11078 has been updated by stomar (Marcus Stollsteimer).


duerst (Martin D端rst) wrote:
> [...] it doesn't make much sense for these (or anything else from UnicodeNormalize) to appear in the public documentation. If somebody know the magic trick for excluding this module from the documentation, please tell me.

The magic trick is `:nodoc:`. I removed the documentation with r58329.

Regarding the docs for String#unicode_normalize:

The docs _do_ appear in the generated documentation. However, **ruby-doc.org** separates core and stdlib documentation, so http://ruby-doc.org/core-2.4.1/String.html has all the methods defined in string.c, rational.c, ..., while the methods defined in lib/unicode_normalize.rb appear under http://ruby-doc.org/stdlib-2.4.1/libdoc/unicode_normalize/rdoc/String.html.

On the other hand, **docs.ruby-lang.org** shows _all_ methods under the corresponding class's documentation, see https://docs.ruby-lang.org/en/trunk/String.html#method-i-unicode_normalize.

Also, `ri String` lists those methods at the very end of the class documentation.

Hope this helps.

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

* Author: jrochkind (jonathan rochkind)
* Status: Open
* Priority: Normal
* Assignee: drbrain (Eric Hodel)
* Target version: 
* 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/

Unsubscribe: <mailto:[e-mail]?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>