search

quickwit-oss / tantivy-py

Python bindings for Tantivy
MIT License
245 stars 62 forks source link

doc: Add mktestdocs, and tutorial for snippets. Fixes #219 #223

Closed cjrh closed 3 months ago

cjrh commented 3 months ago

Quite a nice feature. The mktestdocs package automates running all the code in the mkdocs documentation. This means we can keep our docs having actually working code. I found a couple bugs while setting this up.

I've also added a short tutorial for snippets, using the existing test as an example.

Sidhant29 commented 3 months ago

This looks good! So essentially the docs code becomes part of the tests so we can see if future releases change the code somehow right ?