moj-analytical-services / splink

Fast, accurate and scalable probabilistic data linkage with support for multiple SQL backends
https://moj-analytical-services.github.io/splink/
MIT License
1.4k stars 151 forks source link

Apply accessibility guidelines to splink documentation #642

Open mamonu opened 2 years ago

mamonu commented 2 years ago
mamonu commented 2 years ago

additionally there is a way to automatically test for accessibility on websites via the node.js package Pa11y. Mostly everything passes on our documentation. Running it on one of the notebook tutorials however gives


 • Error: Img element missing an alt attribute. Use the alt attribute to specify a short text alternative.
   ├── WCAG2AA.Principle1.Guideline1_1.1_1_1.H37
   ├── html > body > div:nth-child(8) > main > div > div:nth-child(3) > article > div:nth-child(15) > div:nth-child(2) > div > div > div > img
   └── <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA6QAAAh6CAYAAACbjNB4AAAAAXNSR0IArs4c6QAAIABJREFUeF7snQnYXsPZxyeI2CO2oKEpgqKUNqittdSui4ooTS1FtbS0tTSf1q5pVa0pRZVPlYaitdS+tBKRamlV1RKfJZbEGklskch3/Q4T533ybOfcc94zz3n+c125SJ4zc+75zT33zH9mzjl95syZM8...

So yeah. need to add alt-text to the images we have on the notebooks