Skip to content

Commit

Permalink
doc: Minor changes in README
Browse files Browse the repository at this point in the history
  • Loading branch information
amarhod authored Apr 21, 2021
1 parent f83d076 commit 172e634
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ on:
jobs:
pdf-bibliography:
name: A job to check bibliography in pdf files
name: A job to check bibliography in PDF files and post summary comment in PR
if: ${{ github.event.label.name == 'essay' }}
runs-on: ubuntu-latest
steps:
Expand All @@ -56,7 +56,7 @@ jobs:
**This YAML file checks the new/modified files in a PR (compared to `origin/main`) when the label `essay` is assigned. If there are PDF files in the PR, the action will try to extract the reference lists and comment on the PR with a summary**


## Example of generated summary for PR comment
## Example of generated comment on PR

### :blue_book: :mag_right: PDF Bibliography summary
### File: examples/example_1.pdf (reference count: 3)
Expand All @@ -65,7 +65,7 @@ jobs:
[2] Albert Einstein. Zur Elektrodynamik bewegter Körper. (German) [On the electrodynamics of moving bodies]. Annalen der Physik, 322(10):891–921, 1905.
[3] Knuth: Computers and Typesetting, http://www-cs-faculty.stanford.edu/~uno/abcde.html 1
```
:x: Could not find reference list for pdf files: examples/example_2.pdf
:x: Could not find reference list for PDF files: examples/example_2.pdf
## Unit tests
Run unit tests with:
Expand Down

0 comments on commit 172e634

Please sign in to comment.