Skip to content

Commit 6ac24d9

Browse files
committed
Update readme and gemspec url and usage
1 parent fcafc8f commit 6ac24d9

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ ReplTypeCompletor.load_rbs # Could take a seconds in large projects
3131
Now you can get completion candidates.
3232
```ruby
3333
array = [1, 2, 3]
34-
class String; def upupup; end; end
35-
result = ReplTypeCompletor.analyze('array.map do str = _1.chr; str.up', binding: binding)
36-
result.completion_candidates #=> ["case", "case!", "to", "upup"]
34+
code_to_complete = 'array.map do str = _1.chr; str.up'
35+
result = ReplTypeCompletor.analyze(code_to_complete, binding: binding, filename: __FILE__)
36+
result.completion_candidates #=> ["case", "case!", "to"]
3737
result.doc_namespace('case') #=> "String#upcase"
3838
```
3939

@@ -45,7 +45,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
4545

4646
## Contributing
4747

48-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/repl_type_completor.
48+
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/repl_type_completor.
4949

5050
When something is wrong, these methods will provide some debug information.
5151
```ruby
@@ -54,7 +54,7 @@ ReplTypeCompletor.rbs_load_started?
5454
ReplTypeCompletor.rbs_loaded?
5555
ReplTypeCompletor.rbs_load_error
5656
ReplTypeCompletor.last_completion_error
57-
ReplTypeCompletor.analyze(code_to_complete, binding: binding)
57+
ReplTypeCompletor.analyze(code_to_complete, binding: binding, filename: __FILE__)
5858
```
5959

6060
## License

repl_type_completor.gemspec

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Gem::Specification.new do |spec|
1010

1111
spec.summary = "Type based completion for REPL."
1212
spec.description = "Type based completion for REPL."
13-
# spec.homepage = "TODO: Put your gem's website or public repo URL here."
13+
spec.homepage = "https://github.com/ruby/repl_type_completor"
1414
spec.license = "MIT"
1515
spec.required_ruby_version = ">= 3.0.0"
1616

1717
spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
1818

19-
# spec.metadata["homepage_uri"] = spec.homepage
20-
# spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
21-
# spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
19+
spec.metadata["homepage_uri"] = spec.homepage
20+
spec.metadata["source_code_uri"] = "https://github.com/ruby/repl_type_completor"
21+
spec.metadata["documentation_uri"] = spec.homepage
2222

2323
# Specify which files should be added to the gem when it is released.
2424
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.

0 commit comments

Comments
 (0)