Skip to content

Commit

Permalink
Improve truncate option documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
EthanC committed Mar 11, 2024
1 parent f1e1e0d commit 3ecbb1a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Construct a handler with your preferred options, then add a new sink to Loguru.

### Installation

Support is guaranteed only for Python 3.11 or greater.
Support is guaranteed only for Python 3.12 or greater.

Once this requirement is met, simply install via your package manager of choice.

Expand Down Expand Up @@ -49,6 +49,7 @@ Upon constructing your handler, the following optional customizations are availa
- **Username**: Username to use for the Discord Webhook message.
- **Avatar**: Image URL to use for the Discord Webhook message.
- **Embed**: Toggle whether to use plain codeblock formatting or rich embeds.
- **Truncate**: Toggle whether to trim length logs instead of uploading as a file.
- **Suppress**: Prevent specific Exception types from being sent to Discord.

## Releases
Expand Down
2 changes: 1 addition & 1 deletion loguru_discord/sink.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def __init__(
Default is `None` (determined by Discord.)
`embed` (`bool`, optional): A toggle to use the Discord Embed format.
Default is `False`.
`truncate` (`bool`, optional): A toggle to trim lengthy logs.
`truncate` (`bool`, optional): A toggle to trim lengthy logs instead of uploading as a file.
Default is `False`.
`suppress` (`list`, optional): An array of Exception types to ignore.
Default is empty.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "loguru-discord"
version = "1.2.0"
version = "1.2.1"
description = "Lightweight, easy-to-use Discord sink for Loguru."
authors = ["EthanC <[email protected]>"]
license = "MIT"
Expand Down

0 comments on commit 3ecbb1a

Please sign in to comment.