Skip to content

Include spell checker in github ci/cd - #665

Merged
RubelMozumder merged 8 commits into
joss_paperfrom
SpellingChecker
Jul 18, 2025
Merged

Include spell checker in github ci/cd#665
RubelMozumder merged 8 commits into
joss_paperfrom
SpellingChecker

Conversation

@RubelMozumder

@RubelMozumder RubelMozumder commented Jul 9, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Spell Check for pynxtools Joss paper.

@lukaspie

lukaspie commented Jul 9, 2025

Copy link
Copy Markdown
Collaborator

In general, this looks good.

We have another solution though at https://github.com/FAIRmat-NFDI/pynxtools/pull/662/files#diff-4dfe935b4852393622c2b414783d1d11e1a868fd8485709124d90208fa61ec8b based on cspell (we are using the same for the nexus_definitions). That one has the advantage that we can run it locally, but you need npm for this. From what I understand, we could also install codespell (i.e,. the same tool as used here) with the docs extra and then we can use it locally as well. I will have a look.

Most likely, for any spellchecker, we will need a list of custom words that will not be checked (e.g., NeXus-specific terms). I think the tool used here also supports this.

@lukaspie

lukaspie commented Jul 9, 2025

Copy link
Copy Markdown
Collaborator

Thought about this a bit more, I think we should probably use cspell instead of codespell. cspell is much more tailored to handling markdown files.

Here's the output of the two on the docs in the master branch:

cspell

lukaspie@lukas:cspell docs/**/*.md
 1/24 docs/how-tos/build-a-plugin.md 368.67ms X
docs/how-tos/build-a-plugin.md:1:18 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:3:5 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:3:16 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:3:194 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:3:385 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:3:450 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:5:56 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:27:5 - Unknown word (mkdocs)
docs/how-tos/build-a-plugin.md:29:5 - Unknown word (pyproject)
docs/how-tos/build-a-plugin.md:32:103 - Unknown word (pyproject)
docs/how-tos/build-a-plugin.md:36:1 - Unknown word (mydatareader)
docs/how-tos/build-a-plugin.md:55:65 - Unknown word (mydata)
docs/how-tos/build-a-plugin.md:58:16 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:61:69 - Unknown word (mydata)
docs/how-tos/build-a-plugin.md:63:15 - Unknown word (nxdls)
docs/how-tos/build-a-plugin.md:64:11 - Unknown word (Xmynxdl)
docs/how-tos/build-a-plugin.md:87:328 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:90:20 - Unknown word (numpy)
docs/how-tos/build-a-plugin.md:90:34 - Unknown word (numpy)
docs/how-tos/build-a-plugin.md:90:47 - Unknown word (numpy)
docs/how-tos/build-a-plugin.md:90:61 - Unknown word (numpy)
docs/how-tos/build-a-plugin.md:90:67 - Unknown word (ints)
docs/how-tos/build-a-plugin.md:100:13 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:103:13 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:103:47 - Unknown word (nxdl)
docs/how-tos/build-a-plugin.md:103:53 - Unknown word (Xmynxdl)
docs/how-tos/build-a-plugin.md:108:13 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:108:138 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:118:82 - Unknown word (assosciated)
docs/how-tos/build-a-plugin.md:128:190 - Unknown word (UNITLESS)
docs/how-tos/build-a-plugin.md:158:5 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:161:13 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:161:36 - Unknown word (mydatareader)
docs/how-tos/build-a-plugin.md:161:51 - Unknown word (nxdl)
docs/how-tos/build-a-plugin.md:161:57 - Unknown word (Xmynxdl)
docs/how-tos/build-a-plugin.md:164:118 - Unknown word (pyproject)
docs/how-tos/build-a-plugin.md:164:167 - Unknown word (nxdl)
docs/how-tos/build-a-plugin.md:168:5 - Unknown word (mkdocs)
 2/24 docs/how-tos/create-nexus-files-by-python.md 18.55ms X
docs/how-tos/create-nexus-files-by-python.md:5:137 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:5:373 - Unknown word (datastructures)
docs/how-tos/create-nexus-files-by-python.md:5:621 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:27:67 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:37:11 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:58:66 - Unknown word (spectrosocopy)
docs/how-tos/create-nexus-files-by-python.md:60:26 - Unknown word (CRTL)
docs/how-tos/create-nexus-files-by-python.md:66:4 - Unknown word (Datafield)
docs/how-tos/create-nexus-files-by-python.md:110:31 - Unknown word (NXDL)
docs/how-tos/create-nexus-files-by-python.md:110:98 - Unknown word (nxdl)
docs/how-tos/create-nexus-files-by-python.md:112:153 - Unknown word (nxdl)
docs/how-tos/create-nexus-files-by-python.md:129:113 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:130:49 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:133:10 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:140:14 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:144:41 - Unknown word (spectrsocopy)
docs/how-tos/create-nexus-files-by-python.md:150:85 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:152:27 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:192:44 - Unknown word (datafields)
docs/how-tos/create-nexus-files-by-python.md:196:116 - Unknown word (Raman)
docs/how-tos/create-nexus-files-by-python.md:229:73 - Unknown word (Raman)
docs/how-tos/create-nexus-files-by-python.md:243:8 - Unknown word (hildebrandt)
docs/how-tos/create-nexus-files-by-python.md:243:23 - Unknown word (physik)
 3/24 docs/how-tos/installation_notes_nxvalidate.md 10.01ms X
docs/how-tos/installation_notes_nxvalidate.md:2:43 - Unknown word (nxvalidate)
docs/how-tos/installation_notes_nxvalidate.md:2:135 - Unknown word (sucessful) fix: (successful)
docs/how-tos/installation_notes_nxvalidate.md:6:3 - Unknown word (cnxvalidate)
docs/how-tos/installation_notes_nxvalidate.md:8:24 - Unknown word (nxvaldiate)
docs/how-tos/installation_notes_nxvalidate.md:15:22 - Unknown word (libhdf)
docs/how-tos/installation_notes_nxvalidate.md:21:7 - Unknown word (nexusvalidate)
docs/how-tos/installation_notes_nxvalidate.md:22:4 - Unknown word (nexusvalidate)
docs/how-tos/installation_notes_nxvalidate.md:24:4 - Unknown word (cnxvalidate)
docs/how-tos/installation_notes_nxvalidate.md:31:3 - Unknown word (cnxvalidate)
docs/how-tos/installation_notes_nxvalidate.md:59:7 - Unknown word (libiconv)
 4/24 docs/how-tos/run-tests-in-parallel.md 8.56ms X
docs/how-tos/run-tests-in-parallel.md:1:12 - Unknown word (pynxtools)
docs/how-tos/run-tests-in-parallel.md:3:6 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:107 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:114 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:3:179 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:198 - Unknown word (pynxtools)
docs/how-tos/run-tests-in-parallel.md:3:218 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:225 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:3:341 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:353 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:17:13 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:17:213 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:17:303 - Unknown word (loadgroup)
docs/how-tos/run-tests-in-parallel.md:20:41 - Unknown word (loadgroup)
docs/how-tos/run-tests-in-parallel.md:25:15 - Unknown word (loadgroup)
 5/24 docs/how-tos/testing-validation-tools.md 21.35ms X
docs/how-tos/testing-validation-tools.md:5:3 - Unknown word (pynxtools)
docs/how-tos/testing-validation-tools.md:6:3 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:7:3 - Unknown word (punx)
docs/how-tos/testing-validation-tools.md:9:69 - Unknown word (pynxtools)
docs/how-tos/testing-validation-tools.md:9:79 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:12:19 - Unknown word (pynxtools)
docs/how-tos/testing-validation-tools.md:14:25 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:16:2 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:16:16 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:17:11 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:20:2 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:20:16 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:21:24 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:22:9 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:25:55 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:49:19 - Unknown word (pynxtools)
docs/how-tos/testing-validation-tools.md:51:25 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:68:46 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:68:97 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:74:24 - Unknown word (Xellips)
docs/how-tos/testing-validation-tools.md:77:19 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:79:27 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:79:49 - Unknown word (FAIRMAT)
docs/how-tos/testing-validation-tools.md:79:114 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:81:13 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:81:329 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:82:166 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:83:170 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:84:299 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:85:196 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:86:108 - Unknown word (STRSIZE)
docs/how-tos/testing-validation-tools.md:86:135 - Unknown word (STRPAD)
docs/how-tos/testing-validation-tools.md:86:150 - Unknown word (NULLTERM)
docs/how-tos/testing-validation-tools.md:86:165 - Unknown word (CSET)
docs/how-tos/testing-validation-tools.md:86:174 - Unknown word (CSET)
docs/how-tos/testing-validation-tools.md:86:190 - Unknown word (CTYPE)
docs/how-tos/testing-validation-tools.md:93:69 - Unknown word (infty)
docs/how-tos/testing-validation-tools.md:96:47 - Unknown word (unitless)
docs/how-tos/testing-validation-tools.md:98:4 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:102:58 - Unknown word (Probem)
docs/how-tos/testing-validation-tools.md:102:142 - Unknown word (infty)
docs/how-tos/testing-validation-tools.md:109:4 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:114:43 - Unknown word (cnxvalidate)
docs/how-tos/testing-validation-tools.md:146:19 - Unknown word (punx)
docs/how-tos/testing-validation-tools.md:147:2 - Unknown word (punx)
docs/how-tos/testing-validation-tools.md:148:27 - Unknown word (NIAC)
docs/how-tos/testing-validation-tools.md:148:38 - Unknown word (definitoon)
docs/how-tos/testing-validation-tools.md:148:101 - Unknown word (punx)
docs/how-tos/testing-validation-tools.md:156:23 - Unknown word (Xellips)
docs/how-tos/testing-validation-tools.md:160:25 - Unknown word (infty)
docs/how-tos/testing-validation-tools.md:169:103 - Unknown word (Xraman)
 6/24 docs/how-tos/transformations.md 1.62ms
 7/24 docs/how-tos/use-multi-format-reader.md 19.22ms X
docs/how-tos/use-multi-format-reader.md:3:238 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:11:19 - Unknown word (purposess)
docs/how-tos/use-multi-format-reader.md:13:25 - Unknown word (nxdl)
docs/how-tos/use-multi-format-reader.md:14:255 - Unknown word (nxdl)
docs/how-tos/use-multi-format-reader.md:69:5 - Unknown word (NXDL)
docs/how-tos/use-multi-format-reader.md:71:134 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:77:65 - Unknown word (mydata)
docs/how-tos/use-multi-format-reader.md:80:6 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:80:16 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:83:69 - Unknown word (mydata)
docs/how-tos/use-multi-format-reader.md:85:15 - Unknown word (nxdls)
docs/how-tos/use-multi-format-reader.md:89:33 - Unknown word (kwargs)
docs/how-tos/use-multi-format-reader.md:90:35 - Unknown word (kwargs)
docs/how-tos/use-multi-format-reader.md:107:171 - Unknown word (NXDL)
docs/how-tos/use-multi-format-reader.md:127:16 - Unknown word (isinstance)
docs/how-tos/use-multi-format-reader.md:130:13 - Unknown word (elif)
docs/how-tos/use-multi-format-reader.md:130:18 - Unknown word (isinstance)
docs/how-tos/use-multi-format-reader.md:179:108 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:182:6 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:182:16 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:221:426 - Unknown word (NXDL)
docs/how-tos/use-multi-format-reader.md:254:114 - Unknown word (dicuss)
docs/how-tos/use-multi-format-reader.md:311:13 - Unknown word (endswith)
docs/how-tos/use-multi-format-reader.md:326:16 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:327:16 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:342:69 - Unknown word (mydata)
docs/how-tos/use-multi-format-reader.md:344:15 - Unknown word (nxdls)
docs/how-tos/use-multi-format-reader.md:348:33 - Unknown word (kwargs)
docs/how-tos/use-multi-format-reader.md:349:35 - Unknown word (kwargs)
docs/how-tos/use-multi-format-reader.md:372:20 - Unknown word (isinstance)
docs/how-tos/use-multi-format-reader.md:375:17 - Unknown word (elif)
docs/how-tos/use-multi-format-reader.md:375:22 - Unknown word (isinstance)
docs/how-tos/use-multi-format-reader.md:413:17 - Unknown word (endswith)
docs/how-tos/use-multi-format-reader.md:426:13 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:426:78 - Unknown word (mydatareader)
docs/how-tos/use-multi-format-reader.md:426:93 - Unknown word (nxdl)
 8/24 docs/how-tos/using-multiple-appdefs.md 2.12ms X
docs/how-tos/using-multiple-appdefs.md:1:35 - Unknown word (appdefs)
 9/24 docs/how-tos/using-pynxtools-test-framework.md 11.29ms X
docs/how-tos/using-pynxtools-test-framework.md:1:39 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:2:6 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:2:86 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:2:155 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:2:206 - Unknown word (generalised)
docs/how-tos/using-pynxtools-test-framework.md:4:43 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:6:16 - Unknown word (pynxtools's)
docs/how-tos/using-pynxtools-test-framework.md:13:8 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:17:38 - Unknown word (abspath)
docs/how-tos/using-pynxtools-test-framework.md:20:2 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:21:6 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:27:21 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:27:64 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:32:5 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:33:21 - Unknown word (NXDL)
docs/how-tos/using-pynxtools-test-framework.md:34:67 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:39:16 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:40:9 - Unknown word (Pytest)
docs/how-tos/using-pynxtools-test-framework.md:42:5 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:42:14 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:43:9 - Unknown word (Pytest)
docs/how-tos/using-pynxtools-test-framework.md:46:23 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:46:66 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:48:29 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:50:7 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:63:54 - Unknown word (skipts)
docs/how-tos/using-pynxtools-test-framework.md:66:107 - Unknown word (mpes)
docs/how-tos/using-pynxtools-test-framework.md:72:78 - Unknown word (pyproject)
docs/how-tos/using-pynxtools-test-framework.md:74:18 - Unknown word (pyproject)
docs/how-tos/using-pynxtools-test-framework.md:114:2 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:115:6 - Unknown word (mainfile)
docs/how-tos/using-pynxtools-test-framework.md:118:31 - Unknown word (mainfile)
docs/how-tos/using-pynxtools-test-framework.md:120:41 - Unknown word (mainfile)
10/24 docs/how-tos/validate-nexus-file.md 42.71ms X
docs/how-tos/validate-nexus-file.md:3:140 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:11:7 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:18:591 - Unknown word (hypothes)
docs/how-tos/validate-nexus-file.md:21:200 - Unknown word (instad)
docs/how-tos/validate-nexus-file.md:32:4 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:34:4 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:36:4 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:42:2 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:44:2 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:46:2 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:61:4 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:63:1 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:86:17 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:86:33 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:127:11 - Unknown word (venv)
docs/how-tos/validate-nexus-file.md:148:12 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:154:4 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:157:57 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:162:17 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:162:33 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:169:44 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:173:37 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:173:87 - Unknown word (Xraman)
docs/how-tos/validate-nexus-file.md:192:24 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:194:44 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:199:46 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:206:44 - Unknown word (ellipsometry)
docs/how-tos/validate-nexus-file.md:210:59 - Unknown word (defintion) fix: (definition)
docs/how-tos/validate-nexus-file.md:242:12 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:298:4 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:303:1 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:303:15 - Unknown word (appdefdir)
docs/how-tos/validate-nexus-file.md:306:4 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:308:8 - Unknown word (appdefdir)
docs/how-tos/validate-nexus-file.md:308:119 - Unknown word (defintions)
docs/how-tos/validate-nexus-file.md:315:35 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:315:85 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:322:54 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:330:61 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:337:22 - Unknown word (libhdf)
docs/how-tos/validate-nexus-file.md:362:33 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:408:34 - Unknown word (sucessfully) fix: (successfully)
docs/how-tos/validate-nexus-file.md:414:44 - Unknown word (avaialble)
docs/how-tos/validate-nexus-file.md:414:59 - Unknown word (programm)
docs/how-tos/validate-nexus-file.md:417:46 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:440:9 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:456:168 - Unknown word (filemanager)
docs/how-tos/validate-nexus-file.md:458:24 - Unknown word (loacted)
docs/how-tos/validate-nexus-file.md:466:61 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:466:117 - Unknown word (appdefdir)
docs/how-tos/validate-nexus-file.md:469:15 - Unknown word (appdefdir)
docs/how-tos/validate-nexus-file.md:480:70 - Unknown word (definiton) fix: (definition)
docs/how-tos/validate-nexus-file.md:505:4 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:507:2 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:520:1 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:520:38 - Unknown word (infile)
docs/how-tos/validate-nexus-file.md:544:13 - Unknown word (lxml)
docs/how-tos/validate-nexus-file.md:545:13 - Unknown word (numpy)
docs/how-tos/validate-nexus-file.md:565:104 - Unknown word (kfra)
docs/how-tos/validate-nexus-file.md:566:92 - Unknown word (kfra)
docs/how-tos/validate-nexus-file.md:567:63 - Unknown word (fxcef)
docs/how-tos/validate-nexus-file.md:567:70 - Unknown word (xfbaa)
docs/how-tos/validate-nexus-file.md:574:45 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:574:95 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:577:39 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:580:45 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:580:96 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:628:33 - Unknown word (hixu)
docs/how-tos/validate-nexus-file.md:628:104 - Unknown word (kfra)
docs/how-tos/validate-nexus-file.md:629:14 - Unknown word (hixu)
docs/how-tos/validate-nexus-file.md:629:85 - Unknown word (kfra)
docs/how-tos/validate-nexus-file.md:663:69 - Unknown word (ellips)
docs/how-tos/validate-nexus-file.md:668:43 - Unknown word (ellips)
docs/how-tos/validate-nexus-file.md:674:43 - Unknown word (ellips)
docs/how-tos/validate-nexus-file.md:683:21 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:685:39 - Unknown word (lastest)
docs/how-tos/validate-nexus-file.md:693:2 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:701:24 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:753:4 - Unknown word (Punx)
docs/how-tos/validate-nexus-file.md:753:29 - Unknown word (definiton) fix: (definition)
docs/how-tos/validate-nexus-file.md:753:60 - Unknown word (definiton) fix: (definition)
docs/how-tos/validate-nexus-file.md:755:29 - Unknown word (availble) fix: (available)
docs/how-tos/validate-nexus-file.md:778:5 - Unknown word (Pynxtools)
docs/how-tos/validate-nexus-file.md:787:8 - Unknown word (hildebrandt)
docs/how-tos/validate-nexus-file.md:787:23 - Unknown word (physik)
11/24 docs/how-tos/writing-an-appdef.md 5.16ms X
docs/how-tos/writing-an-appdef.md:17:7 - Unknown word (appdefs)
docs/how-tos/writing-an-appdef.md:21:18 - Unknown word (appdef)
docs/how-tos/writing-an-appdef.md:22:29 - Unknown word (pynxtools)
docs/how-tos/writing-an-appdef.md:22:58 - Unknown word (pynxtools)
docs/how-tos/writing-an-appdef.md:25:24 - Unknown word (pynxtools)
12/24 docs/index.md 4.63ms X
docs/index.md:11:2 - Unknown word (pynxtools)
docs/index.md:11:370 - Unknown word (pynxtools)
docs/index.md:14:2 - Unknown word (pynxtools)
docs/index.md:17:98 - Unknown word (pynxtools)
docs/index.md:19:294 - Unknown word (NFDI)
docs/index.md:39:19 - Unknown word (pynxtools)
docs/index.md:79:33 - Unknown word (NIAC)
docs/index.md:99:37 - Unknown word (Forschungsgemeinschaft)
13/24 docs/learn/dataconverter-and-readers.md 7.55ms X
docs/learn/dataconverter-and-readers.md:1:22 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:2:33 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:4:6 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:4:28 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:4:206 - Unknown word (NXDL)
docs/learn/dataconverter-and-readers.md:6:5 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:12:169 - Unknown word (NXDL)
docs/learn/dataconverter-and-readers.md:16:92 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:17:51 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:21:20 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:30:185 - Unknown word (mpes)
docs/learn/dataconverter-and-readers.md:32:23 - Unknown word (mpes)
docs/learn/dataconverter-and-readers.md:44:83 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:49:13 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:49:45 - Unknown word (otherfile)
docs/learn/dataconverter-and-readers.md:49:57 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:49:62 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:55:29 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:55:34 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:61:29 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:69:131 - Unknown word (andreader)
docs/learn/dataconverter-and-readers.md:72:15 - Unknown word (practized)
14/24 docs/learn/multi-format-reader.md 20.28ms X
docs/learn/multi-format-reader.md:3:45 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:9:149 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:11:291 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:20:65 - Unknown word (mydata)
docs/learn/multi-format-reader.md:23:6 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:23:16 - Unknown word (dataconverter)
docs/learn/multi-format-reader.md:26:69 - Unknown word (mydata)
docs/learn/multi-format-reader.md:28:33 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:29:35 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:49:7 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:51:10 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:51:19 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:67:23 - Unknown word (splitext)
docs/learn/multi-format-reader.md:82:29 - Unknown word (splitext)
docs/learn/multi-format-reader.md:106:163 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:106:173 - Unknown word (dataconverter)
docs/learn/multi-format-reader.md:130:112 - Unknown word (numpy)
docs/learn/multi-format-reader.md:141:344 - Unknown word (NXDL)
docs/learn/multi-format-reader.md:163:6 - Unknown word (AXISNAME)
docs/learn/multi-format-reader.md:165:20 - Unknown word (mydata)
docs/learn/multi-format-reader.md:206:182 - Unknown word (dataconverter)
docs/learn/multi-format-reader.md:234:32 - Unknown word (addtional) fix: (additional)
docs/learn/multi-format-reader.md:237:5 - Unknown word (destinction)
docs/learn/multi-format-reader.md:237:324 - Unknown word (xarrays)
docs/learn/multi-format-reader.md:247:197 - Unknown word (mydata)
docs/learn/multi-format-reader.md:262:16 - Unknown word (AXISNAME)
docs/learn/multi-format-reader.md:264:140 - Unknown word (AXISNAME)
docs/learn/multi-format-reader.md:280:47 - Unknown word (electronanalyser)
docs/learn/multi-format-reader.md:285:60 - Unknown word (electronanalyser)
docs/learn/multi-format-reader.md:287:69 - Unknown word (ELECTRONANALYSER)
docs/learn/multi-format-reader.md:287:86 - Unknown word (electronanalyser)
docs/learn/multi-format-reader.md:287:202 - Unknown word (ELECTRONANALYSER)
docs/learn/multi-format-reader.md:287:219 - Unknown word (electronanalyser)
docs/learn/multi-format-reader.md:287:352 - Unknown word (ELECTRONANALYSER)
docs/learn/multi-format-reader.md:287:369 - Unknown word (electronanalyser)
15/24 docs/learn/multiple-appdefs.md 7.59ms X
docs/learn/multiple-appdefs.md:25:68 - Unknown word (appdefs)
docs/learn/multiple-appdefs.md:25:122 - Unknown word (appdefs)
docs/learn/multiple-appdefs.md:27:50 - Unknown word (appdef)
docs/learn/multiple-appdefs.md:27:63 - Unknown word (pynxtools)
16/24 docs/learn/nexus-primer.md 4.06ms X
docs/learn/nexus-primer.md:7:232 - Unknown word (ARPES)
docs/learn/nexus-primer.md:34:9 - Unknown word (Appdef)
17/24 docs/learn/nexus-rules.md 6.87ms X
docs/learn/nexus-rules.md:6:4 - Unknown word (Namefitting)
docs/learn/nexus-rules.md:8:215 - Unknown word (NXDL)
docs/learn/nexus-rules.md:14:102 - Unknown word (nxdl)
docs/learn/nexus-rules.md:25:251 - Unknown word (maches)
docs/learn/nexus-rules.md:29:43 - Unknown word (namefitting)
docs/learn/nexus-rules.md:31:551 - Unknown word (pynxtools)
docs/learn/nexus-rules.md:33:32 - Unknown word (namefitting)
docs/learn/nexus-rules.md:37:53 - Unknown word (BLUESKY)
docs/learn/nexus-rules.md:37:65 - Unknown word (DECTRIS)
docs/learn/nexus-rules.md:37:199 - Unknown word (undersorce)
docs/learn/nexus-rules.md:37:241 - Unknown word (namefitting)
docs/learn/nexus-rules.md:41:19 - Unknown word (namefitting)
docs/learn/nexus-rules.md:41:174 - Unknown word (AXISNAME)
docs/learn/nexus-rules.md:41:559 - Unknown word (pynxtools)
18/24 docs/learn/nexus-validation.md 8.32ms X
docs/learn/nexus-validation.md:4:103 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:6:37 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:8:19 - Unknown word (dataconverter)
docs/learn/nexus-validation.md:18:81 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:18:108 - Unknown word (arpes)
docs/learn/nexus-validation.md:20:57 - Unknown word (ARPES)
docs/learn/nexus-validation.md:21:7 - Unknown word (Xarpes)
docs/learn/nexus-validation.md:24:109 - Unknown word (NXDL)
docs/learn/nexus-validation.md:24:230 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:33:2 - Unknown word (MSYS)
docs/learn/nexus-validation.md:33:10 - Unknown word (PATHCONV)
docs/learn/nexus-validation.md:34:58 - Unknown word (MSYS)
docs/learn/nexus-validation.md:34:66 - Unknown word (PATHCONV)
docs/learn/nexus-validation.md:37:1 - Unknown word (MSYS)
docs/learn/nexus-validation.md:37:9 - Unknown word (PATHCONV)
docs/learn/nexus-validation.md:37:36 - Unknown word (Xarpes)
docs/learn/nexus-validation.md:37:60 - Unknown word (analyser)
docs/learn/nexus-validation.md:42:34 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:45:5 - Unknown word (cnxvalidate)
docs/learn/nexus-validation.md:46:5 - Unknown word (punx)
19/24 docs/reference/built-in-readers.md 5.19ms X
docs/reference/built-in-readers.md:2:139 - Unknown word (pynxtools)
docs/reference/built-in-readers.md:5:223 - Unknown word (ouput)
docs/reference/built-in-readers.md:10:44 - Unknown word (pynxtools)
docs/reference/built-in-readers.md:14:112 - Unknown word (xarray)
docs/reference/built-in-readers.md:14:241 - Unknown word (Numpy)
docs/reference/built-in-readers.md:16:42 - Unknown word (NXDL)
docs/reference/built-in-readers.md:17:55 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:20:13 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:20:29 - Unknown word (nxdl)
docs/reference/built-in-readers.md:20:35 - Unknown word (Xmynxdl)
docs/reference/built-in-readers.md:20:65 - Unknown word (mynxdl)
docs/reference/built-in-readers.md:25:224 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:27:60 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:27:374 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:36:18 - Unknown word (NXODD)
docs/reference/built-in-readers.md:36:29 - Unknown word (posint)
docs/reference/built-in-readers.md:36:78 - Unknown word (posint)
docs/reference/built-in-readers.md:43:46 - Unknown word (Bluesky)
docs/reference/built-in-readers.md:67:29 - Unknown word (nxdl)
docs/reference/built-in-readers.md:77:29 - Unknown word (nxdl)
docs/reference/built-in-readers.md:77:34 - Unknown word (nxdl)
docs/reference/built-in-readers.md:86:67 - Unknown word (pynxtools)
docs/reference/built-in-readers.md:88:25 - Unknown word (pynxtools)
20/24 docs/reference/cli-api.md 2.56ms X
docs/reference/cli-api.md:3:2 - Unknown word (pynxtools)
docs/reference/cli-api.md:6:27 - Unknown word (dataconverter)
docs/reference/cli-api.md:6:55 - Unknown word (dataconverter)
docs/reference/cli-api.md:8:5 - Unknown word (mkdocs)
docs/reference/cli-api.md:9:14 - Unknown word (pynxtools)
docs/reference/cli-api.md:9:24 - Unknown word (dataconverter)
docs/reference/cli-api.md:11:17 - Unknown word (dataconverter)
docs/reference/cli-api.md:17:10 - Unknown word (mkdocs)
docs/reference/cli-api.md:18:15 - Unknown word (pynxtools)
docs/reference/cli-api.md:18:25 - Unknown word (dataconverter)
docs/reference/cli-api.md:25:5 - Unknown word (mkdocs)
docs/reference/cli-api.md:26:14 - Unknown word (pynxtools)
docs/reference/cli-api.md:37:5 - Unknown word (mkdocs)
docs/reference/cli-api.md:38:14 - Unknown word (pynxtools)
21/24 docs/reference/definitions.md 1.74ms X
docs/reference/definitions.md:4:53 - Unknown word (NIAC)
docs/reference/definitions.md:6:13 - Unknown word (NIAC)
docs/reference/definitions.md:9:54 - Unknown word (NIAC)
22/24 docs/reference/plugins.md 3.43ms X
docs/reference/plugins.md:2:45 - Unknown word (pynxtools)
docs/reference/plugins.md:2:115 - Unknown word (pynxtools)
docs/reference/plugins.md:5:6 - Unknown word (pynxtools)
docs/reference/plugins.md:5:16 - Unknown word (mpes)
docs/reference/plugins.md:5:132 - Unknown word (MPES)
docs/reference/plugins.md:6:6 - Unknown word (pynxtools)
docs/reference/plugins.md:7:11 - Unknown word (pynxtools)
docs/reference/plugins.md:7:93 - Unknown word (MPES)
docs/reference/plugins.md:16:16 - Unknown word (ellips)
docs/reference/plugins.md:16:90 - Unknown word (ellipsometry)
docs/reference/plugins.md:17:16 - Unknown word (raman)
docs/reference/plugins.md:17:88 - Unknown word (Raman)
docs/reference/plugins.md:33:164 - Unknown word (mpes)
docs/reference/plugins.md:36:23 - Unknown word (mpes)
23/24 docs/tutorial/converting-data-to-nexus.md 20.12ms X
docs/tutorial/converting-data-to-nexus.md:20:70 - Unknown word (pynxtools)
docs/tutorial/converting-data-to-nexus.md:35:13 - Unknown word (pynxtools)
docs/tutorial/converting-data-to-nexus.md:37:13 - Unknown word (pynxtools)
docs/tutorial/converting-data-to-nexus.md:39:30 - Unknown word (dataconverter)
docs/tutorial/converting-data-to-nexus.md:39:136 - Unknown word (pynxtools)
docs/tutorial/converting-data-to-nexus.md:41:1 - Unknown word (dataconverter)
docs/tutorial/converting-data-to-nexus.md:54:123 - Unknown word (experimentator)
docs/tutorial/converting-data-to-nexus.md:58:1 - Unknown word (dataconverter)
docs/tutorial/converting-data-to-nexus.md:61:117 - Unknown word (mbar)
docs/tutorial/converting-data-to-nexus.md:65:38 - Unknown word (pynxtools)
24/24 docs/tutorial/nexus-to-nomad.md 2.57ms
CSpell: Files checked: 24, Issues found: 466 in 22 files.

codespell

lukaspie@lukas: codespell docs/**/*.md
docs/how-tos/build-a-plugin.md:118: assosciated ==> associated
docs/how-tos/installation_notes_nxvalidate.md:2: sucessful ==> successful
docs/how-tos/testing-validation-tools.md:102: Probem ==> Problem
docs/how-tos/use-multi-format-reader.md:254: dicuss ==> discuss
docs/how-tos/validate-nexus-file.md:21: instad ==> instead
docs/how-tos/validate-nexus-file.md:210: defintion ==> definition
docs/how-tos/validate-nexus-file.md:308: defintions ==> definitions
docs/how-tos/validate-nexus-file.md:408: sucessfully ==> successfully
docs/how-tos/validate-nexus-file.md:414: avaialble ==> available
docs/how-tos/validate-nexus-file.md:414: programm ==> program, programme
docs/how-tos/validate-nexus-file.md:458: loacted ==> located
docs/how-tos/validate-nexus-file.md:480: definiton ==> definition
docs/how-tos/validate-nexus-file.md:685: lastest ==> latest, last
docs/how-tos/validate-nexus-file.md:753: definiton ==> definition
docs/how-tos/validate-nexus-file.md:753: definiton ==> definition
docs/how-tos/validate-nexus-file.md:755: availble ==> available
docs/learn/multi-format-reader.md:234: addtional ==> additional
docs/learn/nexus-rules.md:25: maches ==> matches
docs/reference/built-in-readers.md:5: ouput ==> output

Seems like cspell picks up many more issues. For most of them, we can use a custom dict. My suggestion is therefore that we use cspell. Note that it has a a github action as well: https://github.com/streetsidesoftware/cspell-action, so we can just use that:

- name: Spell check paper
  uses: streetsidesoftware/cspell-action@v6
  with:
    files: |
      paper/*.md
    config: cspell.json
    strict: true  # Fails if there are any issues

We can then use the same configuration as in #622.

What do you think @RubelMozumder?

@RubelMozumder

RubelMozumder commented Jul 9, 2025

Copy link
Copy Markdown
Contributor Author

In general, this looks good.

We have another solution though at https://github.com/FAIRmat-NFDI/pynxtools/pull/662/files#diff-4dfe935b4852393622c2b414783d1d11e1a868fd8485709124d90208fa61ec8b based on cspell (we are using the same for the nexus_definitions). That one has the advantage that we can run it locally, but you need npm for this. From what I understand, we could also install codespell (i.e,. the same tool as used here) with the docs extra and then we can use it locally as well. I will have a look.

Most likely, for any spellchecker, we will need a list of custom words that will not be checked (e.g., NeXus-specific terms). I think the tool used here also supports this.

Yeah, I also noticed the cspell, but given the involvement of the JS package manager npm, I have backed off. With codespell, it has nice GitHub action and also handy command line options here. The tool also allows skipping community-driven words via a file (here] (e.g. NeXus) term from the spell checking.

@RubelMozumder

RubelMozumder commented Jul 9, 2025

Copy link
Copy Markdown
Contributor Author

Thought about this a bit more, I think we should probably use cspell instead of codespell. cspell is much more tailored to handling markdown files.

Here's the output of the two on the docs in the master branch:

cspell

lukaspie@lukas:cspell docs/**/*.md
 1/24 docs/how-tos/build-a-plugin.md 368.67ms X
docs/how-tos/build-a-plugin.md:1:18 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:3:5 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:3:16 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:3:194 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:3:385 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:3:450 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:5:56 - Unknown word (pynxtools)
docs/how-tos/build-a-plugin.md:27:5 - Unknown word (mkdocs)
docs/how-tos/build-a-plugin.md:29:5 - Unknown word (pyproject)
docs/how-tos/build-a-plugin.md:32:103 - Unknown word (pyproject)
docs/how-tos/build-a-plugin.md:36:1 - Unknown word (mydatareader)
docs/how-tos/build-a-plugin.md:55:65 - Unknown word (mydata)
docs/how-tos/build-a-plugin.md:58:16 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:61:69 - Unknown word (mydata)
docs/how-tos/build-a-plugin.md:63:15 - Unknown word (nxdls)
docs/how-tos/build-a-plugin.md:64:11 - Unknown word (Xmynxdl)
docs/how-tos/build-a-plugin.md:87:328 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:90:20 - Unknown word (numpy)
docs/how-tos/build-a-plugin.md:90:34 - Unknown word (numpy)
docs/how-tos/build-a-plugin.md:90:47 - Unknown word (numpy)
docs/how-tos/build-a-plugin.md:90:61 - Unknown word (numpy)
docs/how-tos/build-a-plugin.md:90:67 - Unknown word (ints)
docs/how-tos/build-a-plugin.md:100:13 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:103:13 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:103:47 - Unknown word (nxdl)
docs/how-tos/build-a-plugin.md:103:53 - Unknown word (Xmynxdl)
docs/how-tos/build-a-plugin.md:108:13 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:108:138 - Unknown word (NXDL)
docs/how-tos/build-a-plugin.md:118:82 - Unknown word (assosciated)
docs/how-tos/build-a-plugin.md:128:190 - Unknown word (UNITLESS)
docs/how-tos/build-a-plugin.md:158:5 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:161:13 - Unknown word (dataconverter)
docs/how-tos/build-a-plugin.md:161:36 - Unknown word (mydatareader)
docs/how-tos/build-a-plugin.md:161:51 - Unknown word (nxdl)
docs/how-tos/build-a-plugin.md:161:57 - Unknown word (Xmynxdl)
docs/how-tos/build-a-plugin.md:164:118 - Unknown word (pyproject)
docs/how-tos/build-a-plugin.md:164:167 - Unknown word (nxdl)
docs/how-tos/build-a-plugin.md:168:5 - Unknown word (mkdocs)
 2/24 docs/how-tos/create-nexus-files-by-python.md 18.55ms X
docs/how-tos/create-nexus-files-by-python.md:5:137 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:5:373 - Unknown word (datastructures)
docs/how-tos/create-nexus-files-by-python.md:5:621 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:27:67 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:37:11 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:58:66 - Unknown word (spectrosocopy)
docs/how-tos/create-nexus-files-by-python.md:60:26 - Unknown word (CRTL)
docs/how-tos/create-nexus-files-by-python.md:66:4 - Unknown word (Datafield)
docs/how-tos/create-nexus-files-by-python.md:110:31 - Unknown word (NXDL)
docs/how-tos/create-nexus-files-by-python.md:110:98 - Unknown word (nxdl)
docs/how-tos/create-nexus-files-by-python.md:112:153 - Unknown word (nxdl)
docs/how-tos/create-nexus-files-by-python.md:129:113 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:130:49 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:133:10 - Unknown word (pynxtools)
docs/how-tos/create-nexus-files-by-python.md:140:14 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:144:41 - Unknown word (spectrsocopy)
docs/how-tos/create-nexus-files-by-python.md:150:85 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:152:27 - Unknown word (datafield)
docs/how-tos/create-nexus-files-by-python.md:192:44 - Unknown word (datafields)
docs/how-tos/create-nexus-files-by-python.md:196:116 - Unknown word (Raman)
docs/how-tos/create-nexus-files-by-python.md:229:73 - Unknown word (Raman)
docs/how-tos/create-nexus-files-by-python.md:243:8 - Unknown word (hildebrandt)
docs/how-tos/create-nexus-files-by-python.md:243:23 - Unknown word (physik)
 3/24 docs/how-tos/installation_notes_nxvalidate.md 10.01ms X
docs/how-tos/installation_notes_nxvalidate.md:2:43 - Unknown word (nxvalidate)
docs/how-tos/installation_notes_nxvalidate.md:2:135 - Unknown word (sucessful) fix: (successful)
docs/how-tos/installation_notes_nxvalidate.md:6:3 - Unknown word (cnxvalidate)
docs/how-tos/installation_notes_nxvalidate.md:8:24 - Unknown word (nxvaldiate)
docs/how-tos/installation_notes_nxvalidate.md:15:22 - Unknown word (libhdf)
docs/how-tos/installation_notes_nxvalidate.md:21:7 - Unknown word (nexusvalidate)
docs/how-tos/installation_notes_nxvalidate.md:22:4 - Unknown word (nexusvalidate)
docs/how-tos/installation_notes_nxvalidate.md:24:4 - Unknown word (cnxvalidate)
docs/how-tos/installation_notes_nxvalidate.md:31:3 - Unknown word (cnxvalidate)
docs/how-tos/installation_notes_nxvalidate.md:59:7 - Unknown word (libiconv)
 4/24 docs/how-tos/run-tests-in-parallel.md 8.56ms X
docs/how-tos/run-tests-in-parallel.md:1:12 - Unknown word (pynxtools)
docs/how-tos/run-tests-in-parallel.md:3:6 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:107 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:114 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:3:179 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:198 - Unknown word (pynxtools)
docs/how-tos/run-tests-in-parallel.md:3:218 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:225 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:3:341 - Unknown word (pytest)
docs/how-tos/run-tests-in-parallel.md:3:353 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:17:13 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:17:213 - Unknown word (xdist)
docs/how-tos/run-tests-in-parallel.md:17:303 - Unknown word (loadgroup)
docs/how-tos/run-tests-in-parallel.md:20:41 - Unknown word (loadgroup)
docs/how-tos/run-tests-in-parallel.md:25:15 - Unknown word (loadgroup)
 5/24 docs/how-tos/testing-validation-tools.md 21.35ms X
docs/how-tos/testing-validation-tools.md:5:3 - Unknown word (pynxtools)
docs/how-tos/testing-validation-tools.md:6:3 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:7:3 - Unknown word (punx)
docs/how-tos/testing-validation-tools.md:9:69 - Unknown word (pynxtools)
docs/how-tos/testing-validation-tools.md:9:79 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:12:19 - Unknown word (pynxtools)
docs/how-tos/testing-validation-tools.md:14:25 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:16:2 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:16:16 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:17:11 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:20:2 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:20:16 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:21:24 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:22:9 - Unknown word (nxdl)
docs/how-tos/testing-validation-tools.md:25:55 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:49:19 - Unknown word (pynxtools)
docs/how-tos/testing-validation-tools.md:51:25 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:68:46 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:68:97 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:74:24 - Unknown word (Xellips)
docs/how-tos/testing-validation-tools.md:77:19 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:79:27 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:79:49 - Unknown word (FAIRMAT)
docs/how-tos/testing-validation-tools.md:79:114 - Unknown word (ellips)
docs/how-tos/testing-validation-tools.md:81:13 - Unknown word (Xellipsometry)
docs/how-tos/testing-validation-tools.md:81:329 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:82:166 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:83:170 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:84:299 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:85:196 - Unknown word (Pynxtools)
docs/how-tos/testing-validation-tools.md:86:108 - Unknown word (STRSIZE)
docs/how-tos/testing-validation-tools.md:86:135 - Unknown word (STRPAD)
docs/how-tos/testing-validation-tools.md:86:150 - Unknown word (NULLTERM)
docs/how-tos/testing-validation-tools.md:86:165 - Unknown word (CSET)
docs/how-tos/testing-validation-tools.md:86:174 - Unknown word (CSET)
docs/how-tos/testing-validation-tools.md:86:190 - Unknown word (CTYPE)
docs/how-tos/testing-validation-tools.md:93:69 - Unknown word (infty)
docs/how-tos/testing-validation-tools.md:96:47 - Unknown word (unitless)
docs/how-tos/testing-validation-tools.md:98:4 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:102:58 - Unknown word (Probem)
docs/how-tos/testing-validation-tools.md:102:142 - Unknown word (infty)
docs/how-tos/testing-validation-tools.md:109:4 - Unknown word (nxvalidate)
docs/how-tos/testing-validation-tools.md:114:43 - Unknown word (cnxvalidate)
docs/how-tos/testing-validation-tools.md:146:19 - Unknown word (punx)
docs/how-tos/testing-validation-tools.md:147:2 - Unknown word (punx)
docs/how-tos/testing-validation-tools.md:148:27 - Unknown word (NIAC)
docs/how-tos/testing-validation-tools.md:148:38 - Unknown word (definitoon)
docs/how-tos/testing-validation-tools.md:148:101 - Unknown word (punx)
docs/how-tos/testing-validation-tools.md:156:23 - Unknown word (Xellips)
docs/how-tos/testing-validation-tools.md:160:25 - Unknown word (infty)
docs/how-tos/testing-validation-tools.md:169:103 - Unknown word (Xraman)
 6/24 docs/how-tos/transformations.md 1.62ms
 7/24 docs/how-tos/use-multi-format-reader.md 19.22ms X
docs/how-tos/use-multi-format-reader.md:3:238 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:11:19 - Unknown word (purposess)
docs/how-tos/use-multi-format-reader.md:13:25 - Unknown word (nxdl)
docs/how-tos/use-multi-format-reader.md:14:255 - Unknown word (nxdl)
docs/how-tos/use-multi-format-reader.md:69:5 - Unknown word (NXDL)
docs/how-tos/use-multi-format-reader.md:71:134 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:77:65 - Unknown word (mydata)
docs/how-tos/use-multi-format-reader.md:80:6 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:80:16 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:83:69 - Unknown word (mydata)
docs/how-tos/use-multi-format-reader.md:85:15 - Unknown word (nxdls)
docs/how-tos/use-multi-format-reader.md:89:33 - Unknown word (kwargs)
docs/how-tos/use-multi-format-reader.md:90:35 - Unknown word (kwargs)
docs/how-tos/use-multi-format-reader.md:107:171 - Unknown word (NXDL)
docs/how-tos/use-multi-format-reader.md:127:16 - Unknown word (isinstance)
docs/how-tos/use-multi-format-reader.md:130:13 - Unknown word (elif)
docs/how-tos/use-multi-format-reader.md:130:18 - Unknown word (isinstance)
docs/how-tos/use-multi-format-reader.md:179:108 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:182:6 - Unknown word (pynxtools)
docs/how-tos/use-multi-format-reader.md:182:16 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:221:426 - Unknown word (NXDL)
docs/how-tos/use-multi-format-reader.md:254:114 - Unknown word (dicuss)
docs/how-tos/use-multi-format-reader.md:311:13 - Unknown word (endswith)
docs/how-tos/use-multi-format-reader.md:326:16 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:327:16 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:342:69 - Unknown word (mydata)
docs/how-tos/use-multi-format-reader.md:344:15 - Unknown word (nxdls)
docs/how-tos/use-multi-format-reader.md:348:33 - Unknown word (kwargs)
docs/how-tos/use-multi-format-reader.md:349:35 - Unknown word (kwargs)
docs/how-tos/use-multi-format-reader.md:372:20 - Unknown word (isinstance)
docs/how-tos/use-multi-format-reader.md:375:17 - Unknown word (elif)
docs/how-tos/use-multi-format-reader.md:375:22 - Unknown word (isinstance)
docs/how-tos/use-multi-format-reader.md:413:17 - Unknown word (endswith)
docs/how-tos/use-multi-format-reader.md:426:13 - Unknown word (dataconverter)
docs/how-tos/use-multi-format-reader.md:426:78 - Unknown word (mydatareader)
docs/how-tos/use-multi-format-reader.md:426:93 - Unknown word (nxdl)
 8/24 docs/how-tos/using-multiple-appdefs.md 2.12ms X
docs/how-tos/using-multiple-appdefs.md:1:35 - Unknown word (appdefs)
 9/24 docs/how-tos/using-pynxtools-test-framework.md 11.29ms X
docs/how-tos/using-pynxtools-test-framework.md:1:39 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:2:6 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:2:86 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:2:155 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:2:206 - Unknown word (generalised)
docs/how-tos/using-pynxtools-test-framework.md:4:43 - Unknown word (pynxtools)
docs/how-tos/using-pynxtools-test-framework.md:6:16 - Unknown word (pynxtools's)
docs/how-tos/using-pynxtools-test-framework.md:13:8 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:17:38 - Unknown word (abspath)
docs/how-tos/using-pynxtools-test-framework.md:20:2 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:21:6 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:27:21 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:27:64 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:32:5 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:33:21 - Unknown word (NXDL)
docs/how-tos/using-pynxtools-test-framework.md:34:67 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:39:16 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:40:9 - Unknown word (Pytest)
docs/how-tos/using-pynxtools-test-framework.md:42:5 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:42:14 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:43:9 - Unknown word (Pytest)
docs/how-tos/using-pynxtools-test-framework.md:46:23 - Unknown word (nxdl)
docs/how-tos/using-pynxtools-test-framework.md:46:66 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:48:29 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:50:7 - Unknown word (caplog)
docs/how-tos/using-pynxtools-test-framework.md:63:54 - Unknown word (skipts)
docs/how-tos/using-pynxtools-test-framework.md:66:107 - Unknown word (mpes)
docs/how-tos/using-pynxtools-test-framework.md:72:78 - Unknown word (pyproject)
docs/how-tos/using-pynxtools-test-framework.md:74:18 - Unknown word (pyproject)
docs/how-tos/using-pynxtools-test-framework.md:114:2 - Unknown word (pytest)
docs/how-tos/using-pynxtools-test-framework.md:115:6 - Unknown word (mainfile)
docs/how-tos/using-pynxtools-test-framework.md:118:31 - Unknown word (mainfile)
docs/how-tos/using-pynxtools-test-framework.md:120:41 - Unknown word (mainfile)
10/24 docs/how-tos/validate-nexus-file.md 42.71ms X
docs/how-tos/validate-nexus-file.md:3:140 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:11:7 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:18:591 - Unknown word (hypothes)
docs/how-tos/validate-nexus-file.md:21:200 - Unknown word (instad)
docs/how-tos/validate-nexus-file.md:32:4 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:34:4 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:36:4 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:42:2 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:44:2 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:46:2 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:61:4 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:63:1 - Unknown word (pynxtools)
docs/how-tos/validate-nexus-file.md:86:17 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:86:33 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:127:11 - Unknown word (venv)
docs/how-tos/validate-nexus-file.md:148:12 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:154:4 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:157:57 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:162:17 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:162:33 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:169:44 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:173:37 - Unknown word (Raman)
docs/how-tos/validate-nexus-file.md:173:87 - Unknown word (Xraman)
docs/how-tos/validate-nexus-file.md:192:24 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:194:44 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:199:46 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:206:44 - Unknown word (ellipsometry)
docs/how-tos/validate-nexus-file.md:210:59 - Unknown word (defintion) fix: (definition)
docs/how-tos/validate-nexus-file.md:242:12 - Unknown word (nexusvalidation)
docs/how-tos/validate-nexus-file.md:298:4 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:303:1 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:303:15 - Unknown word (appdefdir)
docs/how-tos/validate-nexus-file.md:306:4 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:308:8 - Unknown word (appdefdir)
docs/how-tos/validate-nexus-file.md:308:119 - Unknown word (defintions)
docs/how-tos/validate-nexus-file.md:315:35 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:315:85 - Unknown word (nxdl)
docs/how-tos/validate-nexus-file.md:322:54 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:330:61 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:337:22 - Unknown word (libhdf)
docs/how-tos/validate-nexus-file.md:362:33 - Unknown word (cnxvalidate)
docs/how-tos/validate-nexus-file.md:408:34 - Unknown word (sucessfully) fix: (successfully)
docs/how-tos/validate-nexus-file.md:414:44 - Unknown word (avaialble)
docs/how-tos/validate-nexus-file.md:414:59 - Unknown word (programm)
docs/how-tos/validate-nexus-file.md:417:46 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:440:9 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:456:168 - Unknown word (filemanager)
docs/how-tos/validate-nexus-file.md:458:24 - Unknown word (loacted)
docs/how-tos/validate-nexus-file.md:466:61 - Unknown word (nxvalidate)
docs/how-tos/validate-nexus-file.md:466:117 - Unknown word (appdefdir)
docs/how-tos/validate-nexus-file.md:469:15 - Unknown word (appdefdir)
docs/how-tos/validate-nexus-file.md:480:70 - Unknown word (definiton) fix: (definition)
docs/how-tos/validate-nexus-file.md:505:4 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:507:2 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:520:1 - Unknown word (punx)
docs/how-tos/validate-nexus-file.md:520:38 - Unknown word (infile)
docs/how-tos/validate-nexus-file.md:544:13 - Unknown word (lxml)
docs/how-tos/validate-nexus-file.md:545:13 - Unknown word (numpy)
docs/how-tos/validate-nexus-file.md:565:104 - Unknown word (kfra)
docs/how-tos/validate-nexus-file.md:566:92 - Unknown word (kfra)
docs/how-tos/validate-nexus-file.md:567:63 - Unknown word (fxcef)
docs/how-tos/validate-nexus-file.md:567:70 - Unknown word (xfbaa)
docs/how-tos/validate-nexus-file.md:574:45 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:574:95 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:577:39 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:580:45 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:580:96 - Unknown word (NXDL)
docs/how-tos/validate-nexus-file.md:628:33 - Unknown word (hixu)
docs/how-tos/validate-nexus-file.md:628:104 - Unknown word (kfra)
docs/how-tos/validate-nexus-file.md:629:14 - Unknown word (hixu)
docs/how-tos/validate-nexus-file.md:629:85 - Unknown word (kfra)
docs/how-tos/validate-nexus-file.md:663:69 - Unknown word (ellips)
docs/how-tos/validate-nexus-file.md:668:43 - Unknown word (ellips)
docs/how-tos/validate-nexus-file.md:674:43 - Unknown word (ellips)
docs/how-tos/validate-nexus-file.md:683:21 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:685:39 - Unknown word (lastest)
docs/how-tos/validate-nexus-file.md:693:2 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:701:24 - Unknown word (NIAC)
docs/how-tos/validate-nexus-file.md:753:4 - Unknown word (Punx)
docs/how-tos/validate-nexus-file.md:753:29 - Unknown word (definiton) fix: (definition)
docs/how-tos/validate-nexus-file.md:753:60 - Unknown word (definiton) fix: (definition)
docs/how-tos/validate-nexus-file.md:755:29 - Unknown word (availble) fix: (available)
docs/how-tos/validate-nexus-file.md:778:5 - Unknown word (Pynxtools)
docs/how-tos/validate-nexus-file.md:787:8 - Unknown word (hildebrandt)
docs/how-tos/validate-nexus-file.md:787:23 - Unknown word (physik)
11/24 docs/how-tos/writing-an-appdef.md 5.16ms X
docs/how-tos/writing-an-appdef.md:17:7 - Unknown word (appdefs)
docs/how-tos/writing-an-appdef.md:21:18 - Unknown word (appdef)
docs/how-tos/writing-an-appdef.md:22:29 - Unknown word (pynxtools)
docs/how-tos/writing-an-appdef.md:22:58 - Unknown word (pynxtools)
docs/how-tos/writing-an-appdef.md:25:24 - Unknown word (pynxtools)
12/24 docs/index.md 4.63ms X
docs/index.md:11:2 - Unknown word (pynxtools)
docs/index.md:11:370 - Unknown word (pynxtools)
docs/index.md:14:2 - Unknown word (pynxtools)
docs/index.md:17:98 - Unknown word (pynxtools)
docs/index.md:19:294 - Unknown word (NFDI)
docs/index.md:39:19 - Unknown word (pynxtools)
docs/index.md:79:33 - Unknown word (NIAC)
docs/index.md:99:37 - Unknown word (Forschungsgemeinschaft)
13/24 docs/learn/dataconverter-and-readers.md 7.55ms X
docs/learn/dataconverter-and-readers.md:1:22 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:2:33 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:4:6 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:4:28 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:4:206 - Unknown word (NXDL)
docs/learn/dataconverter-and-readers.md:6:5 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:12:169 - Unknown word (NXDL)
docs/learn/dataconverter-and-readers.md:16:92 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:17:51 - Unknown word (pynxtools)
docs/learn/dataconverter-and-readers.md:21:20 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:30:185 - Unknown word (mpes)
docs/learn/dataconverter-and-readers.md:32:23 - Unknown word (mpes)
docs/learn/dataconverter-and-readers.md:44:83 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:49:13 - Unknown word (dataconverter)
docs/learn/dataconverter-and-readers.md:49:45 - Unknown word (otherfile)
docs/learn/dataconverter-and-readers.md:49:57 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:49:62 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:55:29 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:55:34 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:61:29 - Unknown word (nxdl)
docs/learn/dataconverter-and-readers.md:69:131 - Unknown word (andreader)
docs/learn/dataconverter-and-readers.md:72:15 - Unknown word (practized)
14/24 docs/learn/multi-format-reader.md 20.28ms X
docs/learn/multi-format-reader.md:3:45 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:9:149 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:11:291 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:20:65 - Unknown word (mydata)
docs/learn/multi-format-reader.md:23:6 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:23:16 - Unknown word (dataconverter)
docs/learn/multi-format-reader.md:26:69 - Unknown word (mydata)
docs/learn/multi-format-reader.md:28:33 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:29:35 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:49:7 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:51:10 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:51:19 - Unknown word (kwargs)
docs/learn/multi-format-reader.md:67:23 - Unknown word (splitext)
docs/learn/multi-format-reader.md:82:29 - Unknown word (splitext)
docs/learn/multi-format-reader.md:106:163 - Unknown word (pynxtools)
docs/learn/multi-format-reader.md:106:173 - Unknown word (dataconverter)
docs/learn/multi-format-reader.md:130:112 - Unknown word (numpy)
docs/learn/multi-format-reader.md:141:344 - Unknown word (NXDL)
docs/learn/multi-format-reader.md:163:6 - Unknown word (AXISNAME)
docs/learn/multi-format-reader.md:165:20 - Unknown word (mydata)
docs/learn/multi-format-reader.md:206:182 - Unknown word (dataconverter)
docs/learn/multi-format-reader.md:234:32 - Unknown word (addtional) fix: (additional)
docs/learn/multi-format-reader.md:237:5 - Unknown word (destinction)
docs/learn/multi-format-reader.md:237:324 - Unknown word (xarrays)
docs/learn/multi-format-reader.md:247:197 - Unknown word (mydata)
docs/learn/multi-format-reader.md:262:16 - Unknown word (AXISNAME)
docs/learn/multi-format-reader.md:264:140 - Unknown word (AXISNAME)
docs/learn/multi-format-reader.md:280:47 - Unknown word (electronanalyser)
docs/learn/multi-format-reader.md:285:60 - Unknown word (electronanalyser)
docs/learn/multi-format-reader.md:287:69 - Unknown word (ELECTRONANALYSER)
docs/learn/multi-format-reader.md:287:86 - Unknown word (electronanalyser)
docs/learn/multi-format-reader.md:287:202 - Unknown word (ELECTRONANALYSER)
docs/learn/multi-format-reader.md:287:219 - Unknown word (electronanalyser)
docs/learn/multi-format-reader.md:287:352 - Unknown word (ELECTRONANALYSER)
docs/learn/multi-format-reader.md:287:369 - Unknown word (electronanalyser)
15/24 docs/learn/multiple-appdefs.md 7.59ms X
docs/learn/multiple-appdefs.md:25:68 - Unknown word (appdefs)
docs/learn/multiple-appdefs.md:25:122 - Unknown word (appdefs)
docs/learn/multiple-appdefs.md:27:50 - Unknown word (appdef)
docs/learn/multiple-appdefs.md:27:63 - Unknown word (pynxtools)
16/24 docs/learn/nexus-primer.md 4.06ms X
docs/learn/nexus-primer.md:7:232 - Unknown word (ARPES)
docs/learn/nexus-primer.md:34:9 - Unknown word (Appdef)
17/24 docs/learn/nexus-rules.md 6.87ms X
docs/learn/nexus-rules.md:6:4 - Unknown word (Namefitting)
docs/learn/nexus-rules.md:8:215 - Unknown word (NXDL)
docs/learn/nexus-rules.md:14:102 - Unknown word (nxdl)
docs/learn/nexus-rules.md:25:251 - Unknown word (maches)
docs/learn/nexus-rules.md:29:43 - Unknown word (namefitting)
docs/learn/nexus-rules.md:31:551 - Unknown word (pynxtools)
docs/learn/nexus-rules.md:33:32 - Unknown word (namefitting)
docs/learn/nexus-rules.md:37:53 - Unknown word (BLUESKY)
docs/learn/nexus-rules.md:37:65 - Unknown word (DECTRIS)
docs/learn/nexus-rules.md:37:199 - Unknown word (undersorce)
docs/learn/nexus-rules.md:37:241 - Unknown word (namefitting)
docs/learn/nexus-rules.md:41:19 - Unknown word (namefitting)
docs/learn/nexus-rules.md:41:174 - Unknown word (AXISNAME)
docs/learn/nexus-rules.md:41:559 - Unknown word (pynxtools)
18/24 docs/learn/nexus-validation.md 8.32ms X
docs/learn/nexus-validation.md:4:103 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:6:37 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:8:19 - Unknown word (dataconverter)
docs/learn/nexus-validation.md:18:81 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:18:108 - Unknown word (arpes)
docs/learn/nexus-validation.md:20:57 - Unknown word (ARPES)
docs/learn/nexus-validation.md:21:7 - Unknown word (Xarpes)
docs/learn/nexus-validation.md:24:109 - Unknown word (NXDL)
docs/learn/nexus-validation.md:24:230 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:33:2 - Unknown word (MSYS)
docs/learn/nexus-validation.md:33:10 - Unknown word (PATHCONV)
docs/learn/nexus-validation.md:34:58 - Unknown word (MSYS)
docs/learn/nexus-validation.md:34:66 - Unknown word (PATHCONV)
docs/learn/nexus-validation.md:37:1 - Unknown word (MSYS)
docs/learn/nexus-validation.md:37:9 - Unknown word (PATHCONV)
docs/learn/nexus-validation.md:37:36 - Unknown word (Xarpes)
docs/learn/nexus-validation.md:37:60 - Unknown word (analyser)
docs/learn/nexus-validation.md:42:34 - Unknown word (pynxtools)
docs/learn/nexus-validation.md:45:5 - Unknown word (cnxvalidate)
docs/learn/nexus-validation.md:46:5 - Unknown word (punx)
19/24 docs/reference/built-in-readers.md 5.19ms X
docs/reference/built-in-readers.md:2:139 - Unknown word (pynxtools)
docs/reference/built-in-readers.md:5:223 - Unknown word (ouput)
docs/reference/built-in-readers.md:10:44 - Unknown word (pynxtools)
docs/reference/built-in-readers.md:14:112 - Unknown word (xarray)
docs/reference/built-in-readers.md:14:241 - Unknown word (Numpy)
docs/reference/built-in-readers.md:16:42 - Unknown word (NXDL)
docs/reference/built-in-readers.md:17:55 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:20:13 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:20:29 - Unknown word (nxdl)
docs/reference/built-in-readers.md:20:35 - Unknown word (Xmynxdl)
docs/reference/built-in-readers.md:20:65 - Unknown word (mynxdl)
docs/reference/built-in-readers.md:25:224 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:27:60 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:27:374 - Unknown word (dataconverter)
docs/reference/built-in-readers.md:36:18 - Unknown word (NXODD)
docs/reference/built-in-readers.md:36:29 - Unknown word (posint)
docs/reference/built-in-readers.md:36:78 - Unknown word (posint)
docs/reference/built-in-readers.md:43:46 - Unknown word (Bluesky)
docs/reference/built-in-readers.md:67:29 - Unknown word (nxdl)
docs/reference/built-in-readers.md:77:29 - Unknown word (nxdl)
docs/reference/built-in-readers.md:77:34 - Unknown word (nxdl)
docs/reference/built-in-readers.md:86:67 - Unknown word (pynxtools)
docs/reference/built-in-readers.md:88:25 - Unknown word (pynxtools)
20/24 docs/reference/cli-api.md 2.56ms X
docs/reference/cli-api.md:3:2 - Unknown word (pynxtools)
docs/reference/cli-api.md:6:27 - Unknown word (dataconverter)
docs/reference/cli-api.md:6:55 - Unknown word (dataconverter)
docs/reference/cli-api.md:8:5 - Unknown word (mkdocs)
docs/reference/cli-api.md:9:14 - Unknown word (pynxtools)
docs/reference/cli-api.md:9:24 - Unknown word (dataconverter)
docs/reference/cli-api.md:11:17 - Unknown word (dataconverter)
docs/reference/cli-api.md:17:10 - Unknown word (mkdocs)
docs/reference/cli-api.md:18:15 - Unknown word (pynxtools)
docs/reference/cli-api.md:18:25 - Unknown word (dataconverter)
docs/reference/cli-api.md:25:5 - Unknown word (mkdocs)
docs/reference/cli-api.md:26:14 - Unknown word (pynxtools)
docs/reference/cli-api.md:37:5 - Unknown word (mkdocs)
docs/reference/cli-api.md:38:14 - Unknown word (pynxtools)
21/24 docs/reference/definitions.md 1.74ms X
docs/reference/definitions.md:4:53 - Unknown word (NIAC)
docs/reference/definitions.md:6:13 - Unknown word (NIAC)
docs/reference/definitions.md:9:54 - Unknown word (NIAC)
22/24 docs/reference/plugins.md 3.43ms X
docs/reference/plugins.md:2:45 - Unknown word (pynxtools)
docs/reference/plugins.md:2:115 - Unknown word (pynxtools)
docs/reference/plugins.md:5:6 - Unknown word (pynxtools)
docs/reference/plugins.md:5:16 - Unknown word (mpes)
docs/reference/plugins.md:5:132 - Unknown word (MPES)
docs/reference/plugins.md:6:6 - Unknown word (pynxtools)
docs/reference/plugins.md:7:11 - Unknown word (pynxtools)
docs/reference/plugins.md:7:93 - Unknown word (MPES)
docs/reference/plugins.md:16:16 - Unknown word (ellips)
docs/reference/plugins.md:16:90 - Unknown word (ellipsometry)
docs/reference/plugins.md:17:16 - Unknown word (raman)
docs/reference/plugins.md:17:88 - Unknown word (Raman)
docs/reference/plugins.md:33:164 - Unknown word (mpes)
docs/reference/plugins.md:36:23 - Unknown word (mpes)
23/24 docs/tutorial/converting-data-to-nexus.md 20.12ms X
docs/tutorial/converting-data-to-nexus.md:20:70 - Unknown word (pynxtools)
docs/tutorial/converting-data-to-nexus.md:35:13 - Unknown word (pynxtools)
docs/tutorial/converting-data-to-nexus.md:37:13 - Unknown word (pynxtools)
docs/tutorial/converting-data-to-nexus.md:39:30 - Unknown word (dataconverter)
docs/tutorial/converting-data-to-nexus.md:39:136 - Unknown word (pynxtools)
docs/tutorial/converting-data-to-nexus.md:41:1 - Unknown word (dataconverter)
docs/tutorial/converting-data-to-nexus.md:54:123 - Unknown word (experimentator)
docs/tutorial/converting-data-to-nexus.md:58:1 - Unknown word (dataconverter)
docs/tutorial/converting-data-to-nexus.md:61:117 - Unknown word (mbar)
docs/tutorial/converting-data-to-nexus.md:65:38 - Unknown word (pynxtools)
24/24 docs/tutorial/nexus-to-nomad.md 2.57ms
CSpell: Files checked: 24, Issues found: 466 in 22 files.

codespell

lukaspie@lukas: codespell docs/**/*.md
docs/how-tos/build-a-plugin.md:118: assosciated ==> associated
docs/how-tos/installation_notes_nxvalidate.md:2: sucessful ==> successful
docs/how-tos/testing-validation-tools.md:102: Probem ==> Problem
docs/how-tos/use-multi-format-reader.md:254: dicuss ==> discuss
docs/how-tos/validate-nexus-file.md:21: instad ==> instead
docs/how-tos/validate-nexus-file.md:210: defintion ==> definition
docs/how-tos/validate-nexus-file.md:308: defintions ==> definitions
docs/how-tos/validate-nexus-file.md:408: sucessfully ==> successfully
docs/how-tos/validate-nexus-file.md:414: avaialble ==> available
docs/how-tos/validate-nexus-file.md:414: programm ==> program, programme
docs/how-tos/validate-nexus-file.md:458: loacted ==> located
docs/how-tos/validate-nexus-file.md:480: definiton ==> definition
docs/how-tos/validate-nexus-file.md:685: lastest ==> latest, last
docs/how-tos/validate-nexus-file.md:753: definiton ==> definition
docs/how-tos/validate-nexus-file.md:753: definiton ==> definition
docs/how-tos/validate-nexus-file.md:755: availble ==> available
docs/learn/multi-format-reader.md:234: addtional ==> additional
docs/learn/nexus-rules.md:25: maches ==> matches
docs/reference/built-in-readers.md:5: ouput ==> output

Seems like cspell picks up many more issues. For most of them, we can use a custom dict. My suggestion is therefore that we use cspell. Note that it has a a github action as well: https://github.com/streetsidesoftware/cspell-action, so we can just use that:

- name: Spell check paper
  uses: streetsidesoftware/cspell-action@v6
  with:
    files: |
      paper/*.md
    config: cspell.json
    strict: true  # Fails if there are any issues

We can then use the same configuration as in #622.

What do you think @RubelMozumder?

Indeed, it makes total sense to use cspell over codespell. I will try it in my local env.

@lukaspie

lukaspie commented Jul 9, 2025

Copy link
Copy Markdown
Collaborator

In general, this looks good.
We have another solution though at #662 (files) based on cspell (we are using the same for the nexus_definitions). That one has the advantage that we can run it locally, but you need npm for this. From what I understand, we could also install codespell (i.e,. the same tool as used here) with the docs extra and then we can use it locally as well. I will have a look.
Most likely, for any spellchecker, we will need a list of custom words that will not be checked (e.g., NeXus-specific terms). I think the tool used here also supports this.

Yeah, I also noticed the cspell, but given the involvement of the JS package manager npm, I have backed off. With codespell, it has nice GitHub action and also handy command line options here. The tool also allows skipping community-driven words via a file (here] (e.g. NeXus) term from the spell checking.

It's true, for locally checking, one needs npm, but I guess since NOMAD use JS, we will need to use it eventually :D

@RubelMozumder

RubelMozumder commented Jul 9, 2025

Copy link
Copy Markdown
Contributor Author

In general, this looks good.
We have another solution though at #662 (files) based on cspell (we are using the same for the nexus_definitions). That one has the advantage that we can run it locally, but you need npm for this. From what I understand, we could also install codespell (i.e,. the same tool as used here) with the docs extra and then we can use it locally as well. I will have a look.
Most likely, for any spellchecker, we will need a list of custom words that will not be checked (e.g., NeXus-specific terms). I think the tool used here also supports this.

Yeah, I also noticed the cspell, but given the involvement of the JS package manager npm, I have backed off. With codespell, it has nice GitHub action and also handy command line options here. The tool also allows skipping community-driven words via a file (here] (e.g. NeXus) term from the spell checking.

It's true, for locally checking, one needs npm, but I guess since NOMAD use JS, we will need to use it eventually :D

cspell is implemented!

@lukaspie

lukaspie commented Jul 9, 2025

Copy link
Copy Markdown
Collaborator

cspell is implemented!

Okay, good! But why not use the existing configuration in the docs PR?

lukaspie
lukaspie reviewed Jul 9, 2025
View reviewed changes
Comment thread project-words.txt Outdated
lukaspie
lukaspie reviewed Jul 10, 2025
View reviewed changes
Comment thread project-words.txt Outdated
lukaspie
lukaspie reviewed Jul 10, 2025
View reviewed changes
Comment thread project-words.txt Outdated
lukaspie
lukaspie reviewed Jul 10, 2025
View reviewed changes
Comment thread project-words.txt Outdated
@RubelMozumder

RubelMozumder commented Jul 10, 2025

Copy link
Copy Markdown
Contributor Author

@lukaspie it follows the same structural design according to #662.

@lukaspie

lukaspie commented Jul 10, 2025

Copy link
Copy Markdown
Collaborator

@lukaspie it follows the same structural design according to #662.

Great thanks!

lukaspie
lukaspie approved these changes Jul 18, 2025
View reviewed changes

@lukaspie lukaspie left a comment •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good now, please merge. I will adjust in #662

@RubelMozumder
RubelMozumder merged commit 63d327f into joss_paper Jul 18, 2025
@RubelMozumder
RubelMozumder deleted the SpellingChecker branch July 18, 2025 08:31
@lukaspie lukaspie mentioned this pull request Jul 31, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lukaspie lukaspie lukaspie approved these changes
@sherjeelshabih sherjeelshabih Awaiting requested review from sherjeelshabih
@mkuehbach mkuehbach Awaiting requested review from mkuehbach

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@RubelMozumder @lukaspie