David Foster

Results 57 comments of David Foster

On 1., there's a couple of Python tools that provide something similar in an OS-independent way: * [python-dotenv](https://saurabh-kumar.com/python-dotenv/) stores variables in a `.env` file or similar, but requires you to...

Our CI is passing all tests, so you could look to reproduce the CI environment if you want them to pass Many of the tests will fail with older dependencies,...

The commands run by the CI are [here](https://github.com/executablebooks/sphinx-tabs/blob/master/.github/workflows/tests.yml), but in short for Python tests: - create a fresh virtual environment with one of python 3.9 - 3.12 - install dependencies...

We should also see if using the [sphinx external link checker](https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder) would detect these for us in CI. Think this can be used via `sphinx-build -b linkcheck`

We might make exceptions where no equivalent instructions are available elsewhere

Need to define what the standards are, then apply them across the book consistently. Should include the standards in contributing guidance.

[Follow AF guidance](https://analysisfunction.civilservice.gov.uk/policy-store/writing-about-statistics-2/): - Present main messages clearly and concisely - Messages can stand alone - Use plain language - Explain terms the first time they come up

Also mention these next to the checklists (borrowing from [here](https://github.com/best-practice-and-impact/qa-of-code-guidance/compare/main...checklists-rw) so that analysts might caveat where appropriate QA has not been used

A glossary exists under `early_development`, but this was focused on technical terms. We should adapt this to cover more high level terms.