Skip to content

Commit

Permalink
Improve yard documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
gkellogg committed Dec 29, 2021
1 parent 0b3d62c commit 921e8cd
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 7 deletions.
1 change: 0 additions & 1 deletion .yardopts
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@
AUTHORS
UNLICENSE
VERSION
CHANGES.md
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ group :development, :test do
gem 'rdf-turtle', github: "ruby-rdf/rdf-turtle", branch: "develop"
gem 'rdf-vocab', github: "ruby-rdf/rdf-vocab", branch: "develop"
gem 'sxp', github: "dryruby/sxp.rb", branch: "develop"
gem 'rake', '~> 10.0'
gem 'rake', '~> 13.0'
gem 'redcarpet', '~> 3.2.2' unless RUBY_ENGINE == 'jruby'
gem 'byebug', platform: :mri
gem 'psych', platforms: [:mri, :rbx]
Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ losing access to statement-oriented nature of linked data, if you so choose.
It can be used either to access existing RDF data in a resource-oriented way,
or to create a new store of RDF data based on simple defaults.

A changelog is available in the {file:CHANGES.md} file.

### Example

```ruby
Expand Down
8 changes: 6 additions & 2 deletions lib/spira/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,16 @@ def id
# Initialize a new Spira::Base instance of this resource class using
# a new blank node subject. Accepts a hash of arguments for initial
# attributes. To use a URI or existing blank node as a subject, use
# {Spira.for} instead.
# the `.for` method on the subclass instead.
#
# @example
# class Person < Spira::Base; end
# bob = Person.for("bob")
#
# @param [Hash{Symbol => Any}] props Default attributes for this instance
# @yield [self] Executes a given block
# @yieldparam [self] self The newly created instance
# @see Spira.for
# @see Spira::Persistence::ClassMethods#for
# @see RDF::URI#as
# @see RDF::Node#as
def initialize(props = {}, options = {})
Expand Down
2 changes: 1 addition & 1 deletion spira.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
gem.email = 'blavender@gmail.com'

gem.platform = Gem::Platform::RUBY
gem.files = %w(CHANGES.md AUTHORS README.md UNLICENSE VERSION) + Dir.glob('lib/**/*.rb')
gem.files = %w(AUTHORS README.md UNLICENSE VERSION) + Dir.glob('lib/**/*.rb')
gem.require_paths = %w(lib)
gem.has_yardoc = true if gem.respond_to?(:has_yardoc)

Expand Down

0 comments on commit 921e8cd

Please sign in to comment.