Skip to content

Commit

Permalink
documents => documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
simonw authored Jan 10, 2024
1 parent 35c3fbd commit b66fbb0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion sphinx/literalinclude-with-markers.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ async def test_signed_cookie_actor():
```
The rendered documentation [can be seen here](https://docs.datasette.io/en/latest/testing_plugins.html#using-datasette-client-in-tests).

The `# fmt: off` line at the start is an instruction to [Black](https://github.com/psf/black) to ignore that section of the file. Without that, running Black would insist on adding newlines before the closing `# -- end` comments, which would show up [as blank space in the documents](https://github.com/simonw/datasette/issues/2231).
The `# fmt: off` line at the start is an instruction to [Black](https://github.com/psf/black) to ignore that section of the file. Without that, running Black would insist on adding newlines before the closing `# -- end` comments, which would show up [as blank space in the documentation](https://github.com/simonw/datasette/issues/2231).

0 comments on commit b66fbb0

Please sign in to comment.