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.

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

Use @return [self] in Node#terminal! rubydoc #42

Merged
merged 2 commits into from
May 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Most of these help with the gem's overall performance.
- Define delegate methods explicitly and remove dependency on `Forwardable` by [@gonzedge][github_user_gonzedge]
- Reverse char array and use `#pop` instead of slice when adding a word by [@gonzedge][github_user_gonzedge]
- Pull `#scan` up to `Node` by [@gonzedge][github_user_gonzedge]
- Slightly reduce memeory for `Properties` and `ProviderCollection` classes by [@gonzedge][github_user_gonzedge]
- Slightly reduce memory for `Properties` and `ProviderCollection` classes by [@gonzedge][github_user_gonzedge]
- Use `#children_tree` instead of `#children` when possible by [@gonzedge][github_user_gonzedge]
- Remove unnecessary assignment in `#letter=` by [@gonzedge][github_user_gonzedge]
- Use `#each_value` instead of `#values`.`#each` in `Enumerable#each` by [@gonzedge][github_user_gonzedge]
Expand Down Expand Up @@ -345,7 +345,7 @@ Most of these help with the gem's overall performance.
[@gonzedge][github_user_gonzedge]
- Add missing docs by [@gonzedge][github_user_gonzedge]
- Improvements on TravisCI setup by [@gonzedge][github_user_gonzedge]
- Add codeclimate test coverage integration by
- Add CodeClimate test coverage integration by
[@gonzedge][github_user_gonzedge]
- Move rspec config from .rspec to spec_helper by
[@gonzedge][github_user_gonzedge]
Expand Down Expand Up @@ -727,7 +727,7 @@ Most of these help with the gem's overall performance.
- Add guard to Gemfile by [@gonzedge][github_user_gonzedge]
- Add simplecov for code coverage by [@gonzedge][github_user_gonzedge]
- Refactor rambling-trie requires by [@gonzedge][github_user_gonzedge]
- Remov unnecessary internal `#trie_node` by [@gonzedge][github_user_gonzedge]
- Remove unnecessary internal `#trie_node` by [@gonzedge][github_user_gonzedge]
- Refactor specs to "The RSpec Way" by [@gonzedge][github_user_gonzedge]
- Add new benchmarking report info by [@gonzedge][github_user_gonzedge]
- Update RubyDoc.info link and compression info by [@gonzedge][github_user_gonzedge]
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## Contributing to Rambling Trie

1. If you have found a bug or have a feature request, please [search through the issues][github_issues_all] to see if it has already been reported. If that's not the case, then [create a new one][github_issues_new] with a full description of what you have found or what you need.
1. If you have bug fix or a feature implementation in mind, then [fork Rambling Trie][github_fork] and create a branch with a descriptive name.
1. Get the gem up and running locally (tests are written in RSpec):
2. If you have bug fix or a feature implementation in mind, then [fork Rambling Trie][github_fork] and create a branch with a descriptive name.
3. Get the gem up and running locally (tests are written in RSpec):

```sh
bundle install
rake
```

1. Implement your bug fix or feature - ***make sure to add tests!***
1. [Make a Pull Request][github_pull_request]
4. Implement your bug fix or feature - ***make sure to add tests!***
5. [Make a Pull Request][github_pull_request]

Before doing so:

Expand Down
2 changes: 1 addition & 1 deletion lib/rambling/trie/nodes/node.rb
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ def terminal?
end

# Mark {Node Node} as terminal.
# @return [Node] the modified node.
# @return [self] the modified node.
def terminal!
self.terminal = true
self
Expand Down