Skip to content

Commit

Permalink
Modify file_size help doc string (hardbyte#1401)
Browse files Browse the repository at this point in the history
* Modify `file_size` help doc string

* Add note to BLFWriter

* Revert "Add note to BLFWriter"

This reverts commit 18241ac.

* Add in a note about the nuanced file size in help statement

based on input from @zariiii9003

* Modify help statement to clarify consistency

* Minor tweak

* Control BLFWriter max container size

* Fix formatting

* Update can/logger.py

Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com>

* Revert "Fix formatting"

This reverts commit 3afb140.

* Revert "Control BLFWriter max container size"

This reverts commit c39719c.

Co-authored-by: j-c-cook <jack.cook@protonmail.com>
Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com>
  • Loading branch information
3 people committed Oct 7, 2022
1 parent a144f25 commit b639560
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions can/logger.py
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

0 comments on commit b639560

Please sign in to comment.