123456789_123456789_123456789_123456789_123456789_

YardT2 Documentation

Library Listings

Please set font size, see settings...

Site updates done with ruby 2.6.0dev (2018-12-19 trunk 66445) [x64-mingw32]

Browser Choice

As of Dec-2017, the Rails master method list contains approximately 11,000 items, and the AWS method lists have over 40,000 items. Having spent time trying to optimize the javascript for (large) list loading and searching, I'm familiar with the performance issues. The method list has a lot of UI functionality that one may find beneficial. I have found that Firefox does the best job of handling large lists.

What does '* for contributors' mean?

Developers / contributors often remove objects from documentation which are not considered part of the public API.

Libraries listed as '* for contributors' show all objects, and are meant for contributors to the repository.

Hence, if you are using the API, you should not use any classes, modules, methods, or constants that are notated as 'for internal use only'. All of these items will have a red vertical bar (or border) distinguishing them from other objects. Please use the other library versions for API reference.

When you have a minute - UI Guide

YardT2 has quite a few features that are not based on RDoc or YARD. Please read the YardT2 UI Guide, in particular, the 'Search' information, as searching the 'Methods' list works for both name and namespace. 'Start of name' and 'anywhere in name' searches are supported.

Library Notes

All libraries are pulled from their respective GitHub repos. The branch / tag criteria is shown below. The last commit information and date (GMT) are retrieved via the GitHub API.

Ruby

These libraries should correspond to the most recent ruby-lang.org packages. Only 'Ruby trunk' includes c source code.

Version and date info is retrieved from version.h

Rails

Version info is retrieved from version.rb.

AWS SDK for Ruby

Version info is retrieved from VERSION file. At present, the gem is generated frequently, so both branches are rarely more than a few commits past the most recent gem.

As of January 2018, both versions AWS SDK for Ruby have over 11,800 classes and modules, and 40,500 methods.

Loading the Methods list takes a long time, and is not a good idea on tablets. Once loaded, it searches well and is cached, unlike other implementations. Resizing the LIST pane when the Method list is visible is not recommended.

Simply put, loading 30k items into any DOM element is well outside of standard use.

Comments, Bugs, etc

For missing or incorrect documentation, please post an issue on GitHub. If you like the docs, feel free to star the GitHub repo.

For UI suggestions and other questions / comments...

Gitter.io

Thanks

A very special thank you to Loren Segal for his work in creating and maintaining YARD.

Also, thank you to all the contributors that have taken the time to comment / document these libraries.

Copyright

All documented software libraries are copyright their respective owners. See their GitHub repos (AWS SDK for Ruby - Version 2, Ruby on Rails, Ruby) for copyright and license information.

ToDo