https://github.com/cldwalker/bond-yard

bond plugin to generate completions for yard-documented methods
https://github.com/cldwalker/bond-yard

Last synced: about 1 year ago
JSON representation

bond plugin to generate completions for yard-documented methods

• Host: GitHub
• URL: https://github.com/cldwalker/bond-yard
• Owner: cldwalker
• License: mit
• Created: 2011-01-07T09:32:30.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2014-02-14T18:52:18.000Z (over 12 years ago)
• Last Synced: 2025-04-06T18:53:01.422Z (about 1 year ago)
• Language: Ruby
• Size: 121 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc
  • Changelog: CHANGELOG.rdoc
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
== Description

This bond plugin generates completions for gems that have been documented with yard.

== Install

Install the gem with:

    gem install bond-yard

== Usage

Add to your ~/.irbrc

    require 'bond/yard'

In your .irbrc or in the console, load completions for gems that have been documented with yard:

    >> Bond.load_yard_gems 'bond'

    Bond: Building/loading bond's .yardoc database ...

    => ['bond']

    >> Bond.start :[TAB]

    :bare  :debug  :default_mission  :default_search  :eval_binding :eval_debug  :gems  :readline_plugin

For more examples, {see

here}[http://tagaholic.me/2010/05/19/documentation-generated-irb-autocompletions-with-bond-and-yard.html#yard_based_irb_autocompletions].

== Todo

* Generate method autocompletions for any arguments based on yard docs

== Links

* {yard-bond}[https://github.com/postmodern/yard-bond] - Alternative implementation which avoids loading the yardoc cache at runtime