Project

yard-link_stdlib

0.0
No commit activity in last 3 years
No release in over 3 years
yard-link_stdlibnrser/yard-link_stdlibHomepageDocumentationSource CodeBug TrackerWiki
A YARD plugin (with a bit of monkey-business) to support referencing modules, classes, methods, etc. from Ruby's standard library the same way you can reference things in your own code, like {String}. I find this makes the generated documentation considerably more useful and natural.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
16,077
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.1.7
Total releases
9
First release
2018-09-23
Latest release
2021-04-06
 Issues
Open Issues
1
Closed Issues
0
Total Issues
1
Issue Closure Rate
0%
 Development
Primary Language
Ruby
Licenses
BSD
Average date of last 50 commits
2019-07-16
Reverse Dependencies
1

 Dependencies

Development

bundler
>= 1.16
pry
~> 0.14.0
pry-rescue
~> 1.5.2
pry-stack_explorer
~> 0.6.1
rake
~> 13.0
yard-clean
~> 0.1.0
yard-commonmarker
~> 0.5.0
yard-doctest
~> 0.1.16

Runtime

yard
>= 0
 Project Readme

YARD::LinkStdlib

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/yard/link_stdlib. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'yard-link_stdlib'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yard-link_stdlib

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yard-link_stdlib.

License

The gem is available as open source under the terms of the MIT License.