docs: Add documentation for custom filter functions#8
Open
MohamedMohana wants to merge 1 commit intoCleanCocoa:masterfrom
Open
docs: Add documentation for custom filter functions#8MohamedMohana wants to merge 1 commit intoCleanCocoa:masterfrom
MohamedMohana wants to merge 1 commit intoCleanCocoa:masterfrom
Conversation
Addresses issue CleanCocoa#6 - Document how to write your own filter function This commit adds comprehensive documentation for: - Custom filter function type and signature - Multiple examples (exact match, prefix match, FuzzyFind integration) - Custom sorting examples - Default fuzzy filter with custom parameters - Explanation of filter parameters (fuzziness, threshold) This helps users understand how to extend FloatingFilter's filtering capabilities beyond the default fuzzy matching implementation.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR addresses issue #6 by adding comprehensive documentation for writing custom filter functions.
Changes
ItemFiltertype signatureWhy This Matters
The default fuzzy filter works well for most use cases, but custom filters enable:
Testing
Closes #6