Skip to content

Conversation

@msimberg
Copy link
Collaborator

@msimberg msimberg commented Jul 8, 2025

Also: only check changed files for spelling.

@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

@github-actions
Copy link

github-actions bot commented Jul 8, 2025

preview available: https://docs.tds.cscs.ch/189

@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

@github-actions
Copy link

github-actions bot commented Jul 8, 2025

preview available: https://docs.tds.cscs.ch/189

@msimberg msimberg marked this pull request as ready for review July 8, 2025 14:41
@msimberg msimberg requested review from RMeli, bcumming and rsarm as code owners July 8, 2025 14:41
@msimberg msimberg merged commit 12712d0 into eth-cscs:main Jul 8, 2025
1 of 2 checks passed
@msimberg msimberg deleted the fix-typos branch July 8, 2025 14:41
@github-actions
Copy link

github-actions bot commented Jul 8, 2025

preview available: https://docs.tds.cscs.ch/189

@github-actions

This comment has been minimized.

1 similar comment
@github-actions
Copy link

github-actions bot commented Jul 8, 2025

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (339)
ACFDT
Admins
allowfullscreen
alsa
Alternativily
aniso
appdirs
arpack
artifactory
assinged
assings
astunparse
asyncio
autodetection
automake
autoplay
aws
baremetal
batchfile
Besard
blaspp
blocksize
blt
certifi
chatbot
cicd
cmds
cov
cshell
cudnn
cutensor
Cyberduck
Cython
DBCSR
dcomex
DFTB
dftd
diffs
diffutils
DIIS
DIMMs
dla
DNN
Dockerfiles
dockerhub
donfig
dotenv
Dropbear
Dufourspitze
edf
EGFR
eigen
einops
elfutils
ELPA
Epyc
expat
faiss
Fawzi
fftw
filelock
Finalise
findutils
Finetune
finetuned
finetuning
flac
Foket
fontawesome
FPMD
fsspec
fxdiv
gcc
gdb
gdbm
gdrcopy
gettext
gitc
gitdb
github
gitlab
gloo
gmail
gmake
Gmb
gmp
gnuconfig
googletest
gperftools
gpt
gpu
GROMOS
gsl
gtl
harddisks
HDDs
hdf
HEC
hostnames
hotmail
huggingface
hwloc
idna
iframe
ihneriting
img
importlib
iniconfig
Invernizzi
Iopstor
Iopstore
IPy
ironment
itsdangerous
IVO
jfrog
joblib
jobreport
JUHPC
julia
Juliaup
jupyter
JWT
keygen
kokkos
krb
Kwasniewski
lammps
lapack
lapackpp
lexers
libaio
libbsd
libedit
libgit
libiconv
libidn
libint
libjpeg
libmd
libmicrohttpd
libogg
libpciaccess
libpng
libsigsegv
libssh
libtree
libunistring
libuv
libvorbis
Libxc
libxcrypt
libyaml
lifecycle
linalg
linaro
LINKx
linux
LLMs
longterm
lts
lzo
makefiles
Malvoisin
matlab
MDSs
metadynamics
Meteo
mimalloc
MKL
MLp
mozilla
mpc
mpfr
mpich
mpmath
mps
nanoscale
nanotron
nasm
nccl
ncu
netcdf
netlib
netrc
networkx
nghttp
NICS
nltk
nodehours
nonbonded
Nordend
NQL
ntis
NUMA
numactl
numcodecs
numpy
nvcr
nvdashboard
nvfort
nvfortran
nvhpc
nvidia
nvitop
nvpl
nvtx
NWP
octicons
ofi
Omlin
OMP
Oningen
OOM
openblas
openssh
openssl
OPLS
OSSs
OSTs
osu
papi
parmetis
patchelf
pcre
petsc
pigz
Pintarelli
pkgconf
platformdirs
PME
pmi
PMIx
Podladchikov
postbuild
postrun
preformance
preinstalled
Prequisites
Prereleases
Prg
Prioritisation
prioritise
Prioritization
protobuf
pseudopotentials
psimd
psutil
pthreadpool
PWscf
pybind
pycreds
pydantic
pyfirecrest
pygments
pytest
pytz
Quantumespresso
quasiparticles
rccl
rdma
readline
recieve
referrerpolicy
resouces
RGW
ripgrep
ROCM
rowspan
rpath
runtimes
safetensors
Sca
scalapack
Schr
sciapps
sentencepiece
setfacl
setproctitle
setuptools
Signalkuppe
sleef
slepc
Slurmjob
smmap
somwhere
sourcecode
sourced
spdlog
Specifcially
specifiction
Spglib
sphericart
spla
sqlite
squashfile
sshservice
stdexec
sth
sympy
tarball
TDS
Telematics
Terabyte
texinfo
Tgpus
tiktoken
torchmetrics
torchrun
tqdm
traditinal
Trition
trl
UCX
ultrasoft
unlim
urllib
Utkin
uuid
valgrind
vasp
vboost
vclusters
versioneer
waldur
wandb
Werkzeug
wikitext
WLCG
workdir
xcb
Xeon
xfer
xname
xpmem
yasm
zarr
zipp
Zumsteinspitz
Some files were automatically ignored 🙈

These sample patterns would exclude them:

^docs/running/index\.md$

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept these unrecognized words as correct and update file exclusions, you could run the following commands

... in a clone of the git@github.com:msimberg/cscs-docs.git repository
on the fix-typos branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/2d5f9dd9d2d43584d36e4ae03a3508eff411eda9/apply.pl' |
perl - 'https://github.com/eth-cscs/cscs-docs/actions/runs/16146416204/attempts/1' &&
git commit -m 'Update check-spelling metadata'
Available 📚 dictionaries could cover words not in the 📘 dictionary
Dictionary Entries Covers Uniquely
cspell:python/src/python/python.txt 392 14 4
cspell:php/dict/php.txt 1689 10 3
cspell:node/dict/node.txt 891 9 3
cspell:python/src/common/extra.txt 741 3 3
cspell:python/src/python/python-lib.txt 2417 12 2
cspell:html/dict/html.txt 2060 8 2
cspell:npm/dict/npm.txt 302 5 1
cspell:r/src/r.txt 543 5 1
cspell:k8s/dict/k8s.txt 153 5
cspell:java/src/java-terms.txt 920 5
cspell:cpp/src/ecosystem.txt 51 4 2
cspell:golang/dict/go.txt 2099 4
cspell:aws/aws.txt 218 3 1
cspell:fullstack/dict/fullstack.txt 419 3 1
cspell:typescript/dict/typescript.txt 1098 3 1
cspell:css/dict/css.txt 263 3
cspell:public-licenses/src/generated/public-licenses.txt 181 2 2
cspell:powershell/dict/powershell.txt 91 2
cspell:django/dict/django.txt 393 2
cspell:cpp/src/compiler-gcc.txt 17 1

Consider adding them (in .github/workflows/spelling.yaml) in jobs:/spelling: for uses: check-spelling/check-spelling@2d5f9dd9d2d43584d36e4ae03a3508eff411eda9 in its with to extra_dictionaries:

          cspell:python/src/python/python.txt
          cspell:php/dict/php.txt
          cspell:node/dict/node.txt
          cspell:python/src/common/extra.txt
          cspell:python/src/python/python-lib.txt
          cspell:html/dict/html.txt
          cspell:npm/dict/npm.txt
          cspell:r/src/r.txt
          cspell:k8s/dict/k8s.txt
          cspell:java/src/java-terms.txt
          cspell:cpp/src/ecosystem.txt
          cspell:golang/dict/go.txt
          cspell:aws/aws.txt
          cspell:fullstack/dict/fullstack.txt
          cspell:typescript/dict/typescript.txt
          cspell:css/dict/css.txt
          cspell:public-licenses/src/generated/public-licenses.txt
          cspell:powershell/dict/powershell.txt
          cspell:django/dict/django.txt
          cspell:cpp/src/compiler-gcc.txt

ℹ️ Because this workflow is running on: pull_request_target, changes to this workflow file will not take effect as part of a pull request (including this one). You should:

  1. Create a new branch.
  2. Add dictionaries to the workflow file (.github/workflows/spelling.yaml) on that branch.
  3. Test them by pushing that branch.
  4. Do not remove entries from expect files on that branch because the workflow changes that will eventually provide the dictionary coverage won't be applicable to the workflow in the corresponding pull request (they are only available after they're merged to the branch).
  5. Once that branch is merged, you can remove the entries that are no longer needed in another branch.

To stop checking additional dictionaries, add (in .github/workflows/spelling.yaml) for uses: check-spelling/check-spelling@2d5f9dd9d2d43584d36e4ae03a3508eff411eda9 in its with:

check_extra_dictionaries: ""
Warnings ⚠️ (2)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

⚠️ Warnings Count
⚠️ binary-file 1
⚠️ non-alpha-in-dictionary 1

See ⚠️ Event descriptions for more information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant