Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add yard #28

Merged
merged 8 commits into from
Apr 14, 2017
Merged

Add yard #28

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8d1b2fd
added yard gem
inveterateliterate Apr 14, 2017
77e82cd
add error documentation
inveterateliterate Apr 14, 2017
9b2c362
readd error, will remove on merge
inveterateliterate Apr 14, 2017
4f38cde
add yardoc files to gitignore
inveterateliterate Apr 14, 2017
b74eb2a
remove ignored files
inveterateliterate Apr 14, 2017
233d4b4
will put error docs in separate branch
inveterateliterate Apr 14, 2017
8d1eaf1
Merge branch 'master' into add-yard
inveterateliterate Apr 14, 2017
842b7df
Merge branch 'master' into add-yard
inveterateliterate Apr 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.DS_Store
.yardoc
doc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aren't we going to want to check in the docs too?

1 change: 1 addition & 0 deletions .yardopts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--markup markdown
2 changes: 2 additions & 0 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ GEM
specs:
minitest (5.10.1)
rake (10.4.2)
yard (0.9.8)

PLATFORMS
ruby
Expand All @@ -16,6 +17,7 @@ DEPENDENCIES
minitest (~> 5.10.1)
rake (~> 10.4.2)
token_master!
yard

BUNDLED WITH
1.14.5
5 changes: 5 additions & 0 deletions Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
require 'rake/testtask'
require 'yard'

Rake::TestTask.new do |t|
t.libs << 'test'
end

YARD::Rake::YardocTask.new do |t|
t.files = ['lib/**/*.rb']
end

desc "Run tests"
task :default => :test
1 change: 1 addition & 0 deletions token_master.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ Gem::Specification.new do |s|

s.add_development_dependency "rake", "~> 10.4.2"
s.add_development_dependency "minitest", "~> 5.10.1"
s.add_development_dependency "yard"
end