Comments (4)
@Sid-ah This is really an upstream PySpelling question. I imagine your issue is that you need to indent comments
and ignores
more.
The short of it is that YAML can be finicky about indentation in these cases. Options keys need to be nested under the filter name key, not at the same level as the filter name. It thinks you have a multi-key dictionary for your HTML filter. Not a dictionary of options nested dictionary under it specifying option names.
This is not what you want:
namekey:
optionkey: bad
This is what you want:
namekey:
optionkey: good
Users will think they are disabling comments in your example, but they are not actually, so we identify this scenario and throw an error so the user is aware.
Try this which nests the options as a separate dictionary under the filter key.
matrix:
- name: Markdown
aspell:
lang: en
dictionary:
wordlists:
- .wordlist.txt
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
sources:
- '**/*.md'
default_encoding: utf-8
from spellcheck-github-actions.
Thank you @facelessuser! Fixing the indentation did the trick for me.
from spellcheck-github-actions.
No problem, glad I could help 🙂 .
from spellcheck-github-actions.
Thanks @Sid-ah and @facelessuser
I have updated the documentation describing the remedy to avoid this issue, based on your input to this issue.
from spellcheck-github-actions.
Related Issues (20)
- Clarify how Ignore code blocks in Markdown HOT 1
- How spell of latest commit message ? HOT 1
- Action uses non-standard configuration location HOT 3
- Problem with UTF-8 character in wordlist file HOT 4
- How to apply spellcheck action on all markdown files of the repo ? HOT 3
- Git submodules as wordlist? HOT 7
- Unable to build using base images python:3.11.0-slim-bullseye HOT 2
- Using tags for release management HOT 7
- Possible to ignore words in magic commands? HOT 1
- Help: Actions in this workflow must be: within a repository that belongs to your Enterprise account, created by GitHub, or verified in the GitHub Marketplace. HOT 1
- Markdown with html HOT 2
- can you add a feature that ignores specific sections in an md file? HOT 3
- Spelling check failed but GitHub Action succeed HOT 5
- The use of file artifacts suppresses Workflow runs that fail
- Verification Scope Restriction HOT 3
- Support ignoring files HOT 3
- Make pre-commit hook out of this repository HOT 5
- Update problem at 0.28.0 -> 0.29.0 HOT 3
- Paths with spaces in source_files parameter does not work HOT 6
- Support for french HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from spellcheck-github-actions.