docs: add return type explanation for score method #76
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matcher/src/pattern.rs
Outdated
| /// *Note:* The `ignore_case` setting is overwritten to match the casing of | ||
| /// each pattern atom. | ||
| /// | ||
| /// Returns [None] if `needle` from `matcher` is longer than `haystack` |
There was a problem hiding this comment.
Analogous to other docstrings:
Suggested change
| /// Returns [None] if `needle` from `matcher` is longer than `haystack` | |
| /// Returns `None` if `needle` from `matcher` is longer than `haystack` |
|
@gytic Sorry, I have no maintainer permissions, you have to find someone else. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the documentation for the pattern::source method by providing additional context for the return type.
The docstring now specifies, in which Cases None will be returned, as this is unintuitive otherwise.
If a rewording is wanted, please let me know.