Skip to content

Commit

Permalink
Fix typos on readme (#56)
Browse files Browse the repository at this point in the history
* Fix typos on readme

* More typos found
  • Loading branch information
apolkk authored Aug 30, 2024
1 parent 4342136 commit ee4c04a
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Normally these libraries have to take care of a few responsibilities:
- Error logger handler
- Telemetry event handler
- Plugs
- Manual captruing by providing a few public API functions the programmer to call if needed
- Manual capturing by providing a few public API functions the programmer to call if needed
1. Transform these errors into some format for the remote service (specific to remote service), e.g.
- JSON for an HTTP API request
- Subject and body for an e-mail message
Expand All @@ -55,7 +55,7 @@ flowchart LR
```

`Tower`, instead, takes care of capturing errors (number 1), giving them a well defined shape (`Tower.Event` struct)
and pass along this event to pre-configured but seprate reporters which take care of the error reporting steps
and pass along this event to pre-configured but separate reporters which take care of the error reporting steps
(number 2 and 3) depending on which service or remote system they report to.

```mermaid
Expand All @@ -78,7 +78,7 @@ flowchart LR
You can capture once and report to as many places as you want.

Possibly most will end up with just one reporter. But that doesn't mean you shouldn't be able to
easily have many, either temporarily or permantely if you need it.
easily have many, either temporarily or permanently if you need it.

Maybe you just need to have a backup in case one service goes downs or something unexpected happens.

Expand Down Expand Up @@ -109,10 +109,10 @@ flowchart LR
#### 2. Ease of switching services

You can switch from Error Tracking service provider without making any changes to your application error
capturing configuration or expect any change or regression with respect with capturing behvaior.
capturing configuration or expect any change or regression with respect with capturing behavior.

You switch the reporter package, but tower still part of your application, and all the configuration specific
to tower and error captruing tactics is still valid and unchanged.
to tower and error capturing tactics is still valid and unchanged.

#### 3. Response to changes in Elixir and BEAM

Expand All @@ -121,7 +121,7 @@ made in `Tower` without need to change any of the service specific reporters.

## Reporters

As expalained in the Motivation section, any captured errors by `Tower` will be passed along to the list of
As explained in the Motivation section, any captured errors by `Tower` will be passed along to the list of
configured reporters, which can be set in

```elixir
Expand Down
18 changes: 9 additions & 9 deletions lib/tower.ex
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ defmodule Tower do
- Error logger handler
- Telemetry event handler
- Plugs
- Manual captruing by providing a few public API functions the programmer to call if needed
- Manual capturing by providing a few public API functions the programmer to call if needed
1. Transform these errors into some format for the remote service (specific to remote service), e.g.
- JSON for an HTTP API request
- Subject and body for an e-mail message
Expand All @@ -51,7 +51,7 @@ defmodule Tower do
```
`Tower`, instead, takes care of capturing errors (number 1), giving them a well defined shape (`Tower.Event` struct)
and pass along this event to pre-configured but seprate reporters which take care of the error reporting steps
and pass along this event to pre-configured but separate reporters which take care of the error reporting steps
(number 2 and 3) depending on which service or remote system they report to.
```mermaid
Expand All @@ -74,7 +74,7 @@ defmodule Tower do
You can capture once and report to as many places as you want.
Possibly most will end up with just one reporter. But that doesn't mean you shouldn't be able to
easily have many, either temporarily or permantely if you need it.
easily have many, either temporarily or permanently if you need it.
Maybe you just need to have a backup in case one service goes downs or something unexpected happens.
Expand Down Expand Up @@ -105,10 +105,10 @@ defmodule Tower do
#### 2. Ease of switching services
You can switch from Error Tracking service provider without making any changes to your application error
capturing configuration or expect any change or regression with respect with capturing behvaior.
capturing configuration or expect any change or regression with respect with capturing behavior.
You switch the reporter package, but tower still part of your application, and all the configuration specific
to tower and error captruing tactics is still valid and unchanged.
to tower and error capturing tactics is still valid and unchanged.
#### 3. Response to changes in Elixir and BEAM
Expand All @@ -117,7 +117,7 @@ defmodule Tower do
## Reporters
As expalained in the Motivation section, any captured errors by `Tower` will be passed along to the list of
As explained in the Motivation section, any captured errors by `Tower` will be passed along to the list of
configured reporters, which can be set in
config :tower, :reporters, [...] # Defaults to [Tower.EphemeralReporter]
Expand Down Expand Up @@ -149,7 +149,7 @@ defmodule Tower do
manually ask Tower to handle exceptions, throws or exits.
try do
# possibly carshing code
# possibly crashing code
rescue
exception ->
Tower.handle_exception(exception, __STACKTRACE__)
Expand All @@ -163,7 +163,7 @@ defmodule Tower do
or more generally
try do
# possibly carshing code
# possibly crashing code
catch
kind, reason ->
Tower.handle_caught(kind, reason, __STACKTRACE__)
Expand Down Expand Up @@ -389,7 +389,7 @@ defmodule Tower do
Tower.handle_message(:emergency, "System is falling apart")
Tower.handle_message(:error, "Unknown error has ocurred", metadata: %{any_key: "here"})
Tower.handle_message(:error, "Unknown error has occurred", metadata: %{any_key: "here"})
Tower.handle_message(:info, "Just something interesting", metadata: %{interesting: "additional data"})
Expand Down

0 comments on commit ee4c04a

Please sign in to comment.