A few final tweaks necessary – trying to understand configuration file vale.ini
(again)
#768
Replies: 1 comment
-
The only alternative I see is to ignore those files, bvut in vale one can not just say “please do not consider files in the `docs/src/tutorials/” folder (after deactivating the qmd files as well). That is a bit annoying, that one can not ignore files that vale can not handle. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hi there,
vale already helped to work on my documentation a lot, but I think I am struggling with a few final cases
My vale.ini is this one https://github.com/JuliaManifolds/Manopt.jl/blob/4d10893a27917a6a07f2f724ba66f5dfde47ec76/.vale.ini.
The first thing I am not able to do is a common setup for the files
tutorials/*.md
anddocs/src/tutorials/*.md
in a common config block. Currently I tried copying it, but I would prefer to not copy it.Reason for setting them up together is, that they are basically the same files, just that the first (actually
.qmd
) files are Quarto Notebooks while the second folder contains the results of running Quarto.Doing something like
[{tutorials/*.md, docs/src/tutorials/*.md}]
just deactivates that for both (so hits neither). I am unsure how to do this.Second for the quarto notebooks I am a bit confused what vale is actually doing. I get results like
but for example line 80 in that file is actually code so
grad_f
is a variable.See https://github.com/JuliaManifolds/Manopt.jl/blob/4d10893a27917a6a07f2f724ba66f5dfde47ec76/tutorials/EmbeddingObjectives.qmd#L80 for the actual line.
I tried already to
IgnoreTokens
, but that did not work. How do I best handle that?These two problems might be the remaining ones, but they still account for roughly 200 warnings and 200 errors (maybe a few of them are still actual warnings and errors, but it is hard to folter that out manually).
Any help appreciated.
Beta Was this translation helpful? Give feedback.
All reactions