Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ArtyomVancyan committed May 25, 2023
1 parent fde181a commit e296864
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Tests
name: tests

on:
push:
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpysnippet%2Ffuzzymap.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpysnippet%2Ffuzzymap?ref=badge_shield)
[![Tests](https://github.com/pysnippet/fuzzymap/actions/workflows/tests.yml/badge.svg)](https://github.com/pysnippet/fuzzymap/actions/workflows/tests.yml)

## What is the Fuzzy Map?

The Fuzzy Map is a polymorph Python dictionary that always returns the value of the closest similar key. This kind of
dictionary returns the value of the exact key if there is such a key. Otherwise, it will return the value of the most
similar key satisfying the given ratio. The exact mechanism works when setting a new or replacing an old key in the
dictionary. If the key is not found and does not match any of the keys by the given ratio, it returns none.

## Usage with a real-world example
## A real-world example

A live data parser collects the coefficients of sports games from different bookmakers at once, and then an analyzer
tries to find the existing forks. Different bookmakers use different names for the same games. Some of them use the full
Expand Down

0 comments on commit e296864

Please sign in to comment.