Skip to content

Commit

Permalink
Update Codecov action version and improve error message
Browse files Browse the repository at this point in the history
  • Loading branch information
igrek51 committed Jan 30, 2024
1 parent fac9e72 commit dbf3e74
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 12 deletions.
7 changes: 3 additions & 4 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ jobs:
run: make setup-test-unit
- run: . venv/bin/activate && make test

- name: Upload Coverage to Codecov
uses: codecov/codecov-action@v4
env:
token: ${{ secrets.CODECOV_TOKEN }}
- name: Upload Coverage
uses: codecov/codecov-action@v3
token: ${{ secrets.CODECOV_TOKEN }}
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,14 +279,14 @@ with add_context('reloading plugins'):
with add_context('loading config'):
raise RuntimeError('file is missing')
```
This will produce an error message:
This will produce an error with the following message:
```
reloading plugins: loading config: file is missing
```

Note that each individual message part doesn't describe the error well,
but combined, the whole message is very informative.
That's the main idea behind wrapping errors with context.
Note that while each individual part of the message may not provide a comprehensive explanation of the error,
when combined, the whole message becomes highly informative.
This is the core principle behind enriching errors with context.


# Shell Utilities
Expand Down
8 changes: 4 additions & 4 deletions docs/sublog.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ with add_context('reloading plugins'):
with add_context('loading config'):
raise RuntimeError('file is missing')
```
This will produce an error message:
This will produce an error with the following message:
```
reloading plugins: loading config: file is missing
```

Note that each individual message part doesn't describe the error well,
but combined, the whole message is very informative.
That's the main idea behind wrapping errors with context.
Note that while each individual part of the message may not provide a comprehensive explanation of the error,
when combined, the whole message becomes highly informative.
This is the core principle behind enriching errors with context.

0 comments on commit dbf3e74

Please sign in to comment.