Skip to content

Commit

Permalink
Enable spell checking
Browse files Browse the repository at this point in the history
  • Loading branch information
goerz committed Oct 13, 2023
1 parent 7b9e4dd commit b74b756
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 5 deletions.
20 changes: 20 additions & 0 deletions .github/workflows/SpellCheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Spell Check
on:
push:
branches:
- master
- 'release-*'
tags:
- '*'
pull_request:
branches:
- master
jobs:
typos-check:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v4
- name: Check spelling
uses: crate-ci/typos@master
11 changes: 9 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
name: CI
on:
- push
- pull_request
push:
branches:
- master
- 'release-*'
tags:
- '*'
pull_request:
branches:
- master
concurrency:
# Skip intermediate builds: always.
# Cancel intermediate builds: only if it is a pull request build.
Expand Down
2 changes: 2 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[files]
extend-exclude = ["*.bib", "test_formatting.jl"]
2 changes: 1 addition & 1 deletion src/DocumenterCitations.jl
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ function CitationBibliography(bibfile::AbstractString=""; style=nothing)
bibfile_entries = Bibliography.import_bibtex(bibfile)
entries = OrderedDict{String,eltype(values(bibfile_entries))}()
for (bibfile_key, entry) in bibfile_entries
# The `text` in `[text](@cite)` has to be unambigous when
# The `text` in `[text](@cite)` has to be unambiguous when
# round-tripping between String and MarkdownAST.Node. Since `_` and `*`
# can both indicate emphasis in markdown, we normalize to `_` (which
# should be *much* more common in real-life BibTeX keys). The same
Expand Down
2 changes: 1 addition & 1 deletion test/init.jl
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ If `show_coverage` is passed as `true` (default), a coverage summary is shown.
Further, if `genhtml` is `true`, a full HTML coverage report will be generated
in `covdir` (relative to `root`). This requires the `genhtml` executable (part
of the [lcov](http://ltp.sourceforge.net/coverage/lcov.php) package). Instead
of `true`, it is also possible to pass the path to the `genhtml` exectuable.
of `true`, it is also possible to pass the path to the `genhtml` executable.
All other keyword arguments correspond to the respective command line flag for
the `julia` executable that is run as the subprocess.
Expand Down
2 changes: 1 addition & 1 deletion test/test_alphastyle.jl
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ end

lbl1 = format_bibliography_label(dumb, entry("GraceJPB2007"), _c)
@Test lbl1 == "[GBR+07]"
# The dumb style can general labels without any any initalization, while
# The dumb style can generate labels without any any initialization, while
# the smart style *requires* that init_bibliography! was called.
c = IOCapture.capture(rethrow=InterruptException) do
format_bibliography_label(smart, entry("GraceJPB2007"), _c)
Expand Down

0 comments on commit b74b756

Please sign in to comment.