Skip to content

Commit

Permalink
docs: non-features
Browse files Browse the repository at this point in the history
closes #210
closes #212
  • Loading branch information
mightyiam committed Jun 7, 2022
1 parent 0c9d447 commit 802f3fc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Expand Up @@ -10,6 +10,7 @@ michie (pronounced /'mikɪ/) — an attribute macro that adds [memoization] to a
# Table of contents

1. [Features](#features)
1. [Non-features](#non-features)
1. [key_expr](#key_expr)
1. [key_type](#key_type)
1. [store_type](#store_type)
Expand Down Expand Up @@ -40,6 +41,13 @@ michie (pronounced /'mikɪ/) — an attribute macro that adds [memoization] to a
- Supports recursive functions
- Bring your own store

# Non-features

- Caching features: this crate does not provide a caching mechanism other than some trivial implementations.
It allows you to bring your own.
- "Blazingly fast": this crate aims to provide a simple and easy-to-use means of memoizing a function.
If you *actually really* require micro-optimized memoization then you'd most likely have to implement it yourself.

# key_expr

In each invocation a key is obtained.
Expand Down
2 changes: 1 addition & 1 deletion tests/readme.rs
Expand Up @@ -38,7 +38,7 @@ fn limited_character_set_in_headings() {
};
assert!(
text.chars()
.all(|c| c.is_alphanumeric() || c == ' ' || c == '_'),
.all(|c| c.is_alphanumeric() || c == ' ' || c == '_' || c == '-'),
"{}",
text
);
Expand Down

0 comments on commit 802f3fc

Please sign in to comment.