Skip to content

Use correct require statement in docs#2

Merged
mattt merged 1 commit into
package-url:mainfrom
Brcrwilliams:fix-docs
Nov 3, 2022
Merged

Use correct require statement in docs#2
mattt merged 1 commit into
package-url:mainfrom
Brcrwilliams:fix-docs

Conversation

@Brcrwilliams
Copy link
Copy Markdown
Contributor

While the gem is named packageurl-ruby, the module is named package_url and this is the name that must be used when invoking require.

$ gem install packageurl-ruby
Successfully installed packageurl-ruby-0.1.0
Parsing documentation for packageurl-ruby-0.1.0
Done installing documentation for packageurl-ruby after 0 seconds
1 gem installed
$ irb
irb(main):001:0> require 'packageurl-ruby'
Traceback (most recent call last):
        6: from /Users/bwilliams/.asdf/installs/ruby/2.7.5/bin/irb:23:in `<main>'
        5: from /Users/bwilliams/.asdf/installs/ruby/2.7.5/bin/irb:23:in `load'
        4: from /Users/bwilliams/.asdf/installs/ruby/2.7.5/lib/ruby/gems/2.7.0/gems/irb-1.2.6/exe/irb:11:in `<top (required)>'
        3: from (irb):1
        2: from /Users/bwilliams/.asdf/installs/ruby/2.7.5/lib/ruby/site_ruby/2.7.0/rubygems/core_ext/kernel_require.rb:85:in `require'
        1: from /Users/bwilliams/.asdf/installs/ruby/2.7.5/lib/ruby/site_ruby/2.7.0/rubygems/core_ext/kernel_require.rb:85:in `require'
LoadError (cannot load such file -- packageurl-ruby)
irb(main):002:0> require 'package_url'
=> true

Copy link
Copy Markdown
Contributor

@mattt mattt left a comment

Choose a reason for hiding this comment

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

Thanks for catching this, @Brcrwilliams. Apologies for any inconvenience caused by having incorrect setup instructions.

@mattt mattt merged commit 4cdbfac into package-url:main Nov 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants