ropensci / spelling

Tools for Spell Checking in R
https://docs.ropensci.org/spelling
Other
105 stars 27 forks source link

cross references in bookdown #34

Closed maelle closed 5 years ago

maelle commented 5 years ago

I've just realized the WORDLIST in dev_guide is full of things that are "heading identifiers".

This is a fix but probably not the best one.

maelle commented 5 years ago

I forgot my reprex

file <- "# Approval comment template {#approvaltemplate}\n Cool section. Later I will [refer to another one](#myref)"
spelling:::spell_check_file_md(textConnection(file),
                    dict = hunspell::dictionary())
#> approvaltemplate 
#>              "1"

Created on 2019-05-27 by the reprex package (v0.2.1)

codecov-io commented 5 years ago

Codecov Report

Merging #34 into master will increase coverage by 0.17%. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #34      +/-   ##
==========================================
+ Coverage   45.36%   45.54%   +0.17%     
==========================================
  Files           7        7              
  Lines         313      314       +1     
==========================================
+ Hits          142      143       +1     
  Misses        171      171
Impacted Files Coverage Δ
R/parse-markdown.R 84.21% <100%> (+0.87%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update a6f7bb1...821ed26. Read the comment docs.

jeroen commented 5 years ago

I tweaked the regex such that it only matches when the {# ...} block is at the end of a line which must be the case according to the pandoc documentation. Otherwise you get false positives when it matches {# and then somewhere much later in the document it finds the } (possibly another heading identifier.