gtalarico / pyairtable

Python Api Client for Airtable
https://pyairtable.readthedocs.io
MIT License
786 stars 139 forks source link

For discussion: run pytest against docstrings #309

Closed mesozoic closed 11 months ago

mesozoic commented 1 year ago

We've had a number of typos and other errors reported against this project's documentation, and one idea I had was to run pytest against all of the code samples in the docstrings. In order to do this, I needed to:

Limitations/issues with this approach:

The branch has a few examples of the changes required to some of the library's modules in order to make them pass tests. I'm opening this as a WIP to solicit input on whether it's worth continuing down this route, or if I should just grab FakeAirtable (which is useful in other contexts) and ditch the rest.

mesozoic commented 11 months ago

Going to drop this as not feasible for now.