Repository navigation
docs: restructure the README and split the reference into docs/ - #12
Merged
Merged
Conversation
…cblocks - PostQuery::orderBy() sent any direction to WordPress as is; it now throws a QueryException like the other query classes - search docblocks: users need a * for a partial match, sites and networks always match 'contains'
- README: overview, quick start, query classes, index - docs/concepts.md, results.md, upgrading.md - one page per query class and per sub-query, with examples whose output is generated from the code - everything that was stale is rewritten (permission, date hours, pagename, ofType, LIKE...)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #11.
The README had grown to ~1900 lines, was centred on
PostQueryand was partly stale. It is now a short overview, with the reference split into pages underdocs/:README.md: installation, quick start, the query classes, indexdocs/concepts.md(start here),results.md,upgrading.mddocs/post-query.md,term-query.md,user-query.md,comment-query.md,site-network-query.mddocs/tax-query.md,meta-query.md,date-query.mdHow it was checked
upgrading.mdwas checked against the1.0.3tag.Two code fixes found while documenting (separate commit)
PostQuery::orderBy()sent any direction as is; it now throws aQueryExceptionlike the other classes.*for a partial match, sites and networks always match 'contains'.Pest: 242 passed.