Skip to content

docs: add return type explanation for score method #76

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: add return type explanation for score method #76

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c2f370
docs: add return type explanation for score method
gytic Apr 2, 2025
55f3954
docs: adjust typing to other doc-strings
gytic Jul 13, 2025
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
2 changes: 2 additions & 0 deletions matcher/src/pattern.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,8 @@ impl Atom {
///
/// *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`
Copy link

@reneleonhardt reneleonhardt Jul 9, 2025

Choose a reason for hiding this comment

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

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`

pub fn score(&self, haystack: Utf32Str<'_>, matcher: &mut Matcher) -> Option<u16> {
matcher.config.ignore_case = self.ignore_case;
matcher.config.normalize = self.normalize;
Expand Down