Skip to content

Add British English patterns as Lang::EnglishGB #35

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
nathanscully wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add British English patterns as Lang::EnglishGB #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ full = [
"danish",
"dutch",
"english",
"englishgb",
"estonian",
"finnish",
"french",
Expand Down Expand Up @@ -77,6 +78,7 @@ czech = []
danish = []
dutch = []
english = []
englishgb = []
estonian = []
finnish = []
french = []
Expand Down
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ assert_eq!(syllables.join("-"), "ex-ten-sive");
```

## Languages
By default, this crate supports hyphenating 48 languages. Embedding
automata for all these languages will add ~1.1 MiB to your binary.
By default, this crate supports hyphenating 48 languages plus a British
English variant. Embedding automata for all of them will add ~1.2 MiB to your
binary.
Alternatively, you can disable support for all languages and manually choose
which ones get added:

Expand All @@ -40,6 +41,10 @@ which ones get added:
hypher = { version = "0.1", default-features = false, features = ["english", "greek"] }
```

`Lang::English` (code `en`) uses the American patterns. The British patterns
are available separately as `Lang::EnglishGB` behind the `englishgb` feature.
`Lang::from_iso` never selects them, so existing `en` output is unchanged.

Each language added individually contributes:

| Language | Space |
Expand All @@ -56,6 +61,7 @@ Each language added individually contributes:
| Danish | 5.7 KiB |
| Dutch | 63 KiB |
| English | 27 KiB |
| EnglishGB | 43 KiB |
| Estonian | 19 KiB |
| Finnish | 636 B |
| French | 6.9 KiB |
Expand Down
Loading
Loading