{"sha": "e8625695a3b7938f37b64dff09c14e47d9428fe5", "message": "xfail documentation unit tests for view classes, refs #299\n\nMore documentation unit tests. These ones check that every single **View class\nimported into the datasette/app.py module are covered by our documentation.\n\nJust one problem: they aren't documented yet. So I'm using the xfail pytest\ndecorator to mark these tests as allowed-to-fail. When you run the test suite\nyou now get a report of how many views still need to be documented, but it\ndoesn't fail the tests.\n\nThe output looks something like this:\n\n $ pytest tests/test_docs.py\n collected 31 items\n\n tests/test_docs.py ..........................XXXxx. [100%]\n\n ============ 26 passed, 2 xfailed, 3 xpassed in 1.06 seconds ============\n\nOnce I have documented all the views I will remove the xfail so any future\nviews that are added without documentation will cause a test failure.\n\nWe can detect that a view is documented by looking for ReST label in the docs,\nfor example:\n\n .. _IndexView:\n\nSome view classes can be used to power multiple URLs - the JsonDataView class\nfor example is used to power /-/metadata and /-/config and /-/plugins\n\nIn this case, the second part of the label can indicate the variety of page, e.g:\n\n .. _JsonDataView_metadata:\n\nThe test will pass as long as there is at least one label that starts with\n_JsonDataView.", "author_date": "2018-07-28T03:13:26Z", "committer_date": "2018-07-28T03:13:26Z", "raw_author": {"value": "13ae486343ea6454a93114c6f558ffea2f2c6874", "label": "Simon Willison"}, "raw_committer": {"value": "13ae486343ea6454a93114c6f558ffea2f2c6874", "label": "Simon Willison"}, "repo": {"value": 107914493, "label": "datasette"}, "author": {"value": 9599, "label": "simonw"}, "committer": {"value": 9599, "label": "simonw"}}