Expand the search API docs #2344

Merged
merged 1 commit into from Jul 3, 2015

Projects

None yet

4 participants

@seanh
Contributor
seanh commented Jul 2, 2015

This adds docs for many undocumented params and features of the search
API.

Also removes docs of the (legacy) quote param. Annotations no longer
have this field.

@seanh seanh added the WIP label Jul 2, 2015
@seanh seanh self-assigned this Jul 2, 2015
@seanh
Contributor
seanh commented Jul 2, 2015
  • Some of the documented features don't have tests
  • When searching for a uri (or uri.parts?) we expand the search to also cover uris of equivalent documents, should document this (may also affect "any" searches)
  • Add todo for documenting the document param, don't want to document this yet as it's about to change but there should be a todo
@tilgovi
Contributor
tilgovi commented Jul 2, 2015

I don't think uri.parts is expanded and so it doesn't affect any searches either.

URI.parts currently hase . as a delimiter, so the example (example.com) won't do what it describes.

@tilgovi
Contributor
tilgovi commented Jul 2, 2015

Other than that second bit about uri.parts this is so solid, thank you.

@landscape-bot

Code Health
Code quality remained the same when pulling 70d8d3c on hypothesis:extend-search-api-docs into 653f19e on hypothesis:master.

@seanh
Contributor
seanh commented Jul 3, 2015

I can't remember what it was that I wanted to add a test for. Calling this done

@seanh seanh removed their assignment Jul 3, 2015
@landscape-bot

Code Health
Repository health decreased by 0.01% when pulling 95da24c on extend-search-api-docs into 653f19e on master.

@seanh seanh removed the WIP label Jul 3, 2015
Sean Hammond Expand the search API docs
This adds docs for many undocumented params and features of the search
API.

Also removes docs of the (legacy) quote param. Annotations no longer
have this field.

Add a TODO to document the search API's document param

Also add the todo extension to Sphinx.

Pylint: ignore invalid names in docs/conf.py

We don't control these names
57da719
@seanh
Contributor
seanh commented Jul 3, 2015

Rebased, the landscape problem should be fixed (ignored) now

@landscape-bot

Code Health
Repository health increased by 0.30% when pulling 57da719 on extend-search-api-docs into c6be6c1 on master.

@landscape-bot

Code Health
Repository health increased by 0.30% when pulling 57da719 on extend-search-api-docs into c6be6c1 on master.

@nickstenning nickstenning merged commit b3d7b3e into master Jul 3, 2015

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
@nickstenning nickstenning deleted the extend-search-api-docs branch Jul 3, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment