Skip to content

Modify file_size help doc string #1401

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

Merged
merged 12 commits into from
Oct 7, 2022
Merged

Modify file_size help doc string #1401

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6f6c325
Modify `file_size` help doc string
Sep 29, 2022
18241ac
Add note to BLFWriter
Sep 29, 2022
b26fd57
Revert "Add note to BLFWriter"
Sep 29, 2022
a4d04dc
Add in a note about the nuanced file size in help statement
Sep 29, 2022
cced4ad
Modify help statement to clarify consistency
Sep 29, 2022
87ecc64
Minor tweak
Sep 29, 2022
c39719c
Control BLFWriter max container size
Sep 29, 2022
3afb140
Fix formatting
Sep 29, 2022
42c06be
Update can/logger.py
j-c-cook Oct 3, 2022
6fa459d
Revert "Fix formatting"
Oct 3, 2022
053ead4
Revert "Control BLFWriter max container size"
Oct 3, 2022
442d484
Merge branch 'LoggerHelpStatement' of https://github.com/j-c-cook/pyt…
Oct 3, 2022
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions can/logger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,9 +193,10 @@ def main() -> None:
"--file_size",
dest="file_size",
type=int,
help="Maximum file size in bytes (or for the case of blf, maximum "
"buffer size before compression and flush to file). Rotate log "
"file when size threshold is reached.",
help="Maximum file size in bytes. Rotate log file when size threshold "
"is reached. (The resulting file sizes will be consistent, but are not "
"guaranteed to be exactly what is specified here due to the rollover "
"conditions being logger implementation specific.)",
default=None,
)

Expand Down