Skip to content

Commit

Permalink
Fix a few typos (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
pitmonticone authored Oct 24, 2022
1 parent 24584c3 commit b319a52
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions src/how-to/rotate-log-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ for example to keep the individual files below 10MB.
The [LoggingExtras.jl](@ref) package implements the [`DatetimeRotatingFileLogger`]
(@ref LoggingExtras.DatetimeRotatingFileLogger) which, as the name suggests, is a logger
for date/time based log rotation. The frequency of log rotation is determined based
on the input filename patterin in the form of a dateformat (see documentation for [`Dates.DateFormat`](https://docs.julialang.org/en/v1/stdlib/Dates/#Dates.DateFormat) and
on the input filename pattern in the form of a dateformat (see documentation for [`Dates.DateFormat`](https://docs.julialang.org/en/v1/stdlib/Dates/#Dates.DateFormat) and
[`dateformat"..."`](https://docs.julialang.org/en/v1/stdlib/Dates/#Dates.@dateformat_str)).

Let's look at an initial example:
Expand All @@ -38,7 +38,7 @@ rm(logdir; recursive=true, force=true) # hide
```

This is a logger that will rotate the log file every day, since "day" is the smallest
datetime unit in the filaname pattern.
datetime unit in the filename pattern.

!!! note
Note that all characters in the filename pattern that should not be part of of the
Expand All @@ -61,7 +61,7 @@ $ ls logs/
---

Let's now improve the logger by adding two features that are commonly used in `logrotate`:
file compression and file retention policy. Log files are usually quite compressable
file compression and file retention policy. Log files are usually quite compressible
and adding compression could save us some space. A file retention policy let us keep log
files for a fixed number of days, for example 30, and then automatically delete them.
Support for compression and retention policies are not built-in, but there are external
Expand Down
2 changes: 1 addition & 1 deletion src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The aim of this document is to be a "one-stop-shop" for everything related to lo
Julia. The document is structured as follows[^1]:

- _**Tutorials**_ will teach you the basics of Julia's logging system.
- _**How-to guides**_ will guide you through the steps involved in adressing common tasks
- _**How-to guides**_ will guide you through the steps involved in addressing common tasks
and use-cases. They are more advanced than tutorials and assume some knowledge of Julia's
logging system.
- _**Reference**_ contains technical reference of functions and APIs (e.g. the docstrings).
Expand Down
2 changes: 1 addition & 1 deletion src/tutorials/logging-basics.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Logging basics

In this tutorial we will learn the basics of how to emit *log messages* or *log events*.
We will also learn a bit about what information each message consist of and what happens
We will also learn a bit about what information each message consists of and what happens
after the log message is emitted. If you are writing a script or a package this section
should cover everything you need.

Expand Down

0 comments on commit b319a52

Please sign in to comment.