Skip to content
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

Jump to bottom

Update documentation and docstring #16

Merged
merged 2 commits into from
May 16, 2021
Merged

Update documentation and docstring #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14ee90f
Fix documentation
fullonic May 16, 2021
1a3e89b
Update docstring
fullonic May 16, 2021
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: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ app.add_middleware(
**Parameters**:

- _(Optional)_ `quality`: Controls the compression speed vs compression density tradeoff. The higher the quality, the slower the compression. Range is 0 to 11.
- _(Optional)_ `mode`: The compression mode can be: `"generic"` (default), `"text"` (for UTF-8 format text input) or `"font"` (for WOFF 2.0).
- _(Optional)_ `mode`: The compression mode can be: `"generic"`, `"text"` (`Defaul` for UTF-8 format text input) or `"font"` (for WOFF 2.0).
Copy link
Contributor

Choose a reason for hiding this comment

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

note you're missing a t in default

- _(Optional)_ `lgwin`: Base 2 logarithm of the sliding window size. Range is 10 to 24.
- _(Optional)_ `lgblock`: Base 2 logarithm of the maximum input block size. Range is 16 to 24. If set to 0, the value will be set based on the quality.
- _(Optional)_ `minimum_size`: Only compress responses that are bigger than this value in bytes.
Expand Down
2 changes: 1 addition & 1 deletion brotli_asgi/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def __init__(
Arguments.

mode: The compression mode can be:
generic (default), text (for UTF-8 format text input)
generic, text (*default*. Used for UTF-8 format text input)
or font (for WOFF 2.0).
quality: Controls the compression-speed vs compression-
density tradeoff. The higher the quality, the slower the compression.
Expand Down