While writing the MongoDB driver I found the entity query system making certain assumptions about what a group of conditions apply to and after a discussion with bojanz and plach we agreed these make sense but they definitely need to be documented.

CommentFileSizeAuthor
#5 2228711_5.patch2.28 KBchx
#5 interdiff.txt934 byteschx
eq_assumption_docs.patch2.29 KBchx

Comments

bojanz’s picture

bojanz commented

This is a documentation only patch, and clarifies assumptions around a very important part of the API.
DX++

bojanz’s picture

bojanz commented
Status: Needs review » Reviewed & tested by the community

I'll be bold enough to RTBC it even before plach gives a +1.

plach’s picture

plach
he/him
Primary language Italian
Location Venezia
commented

+1 :)

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Needs work

We don't normally want blank lines in the middle of @param documentation. Can you reformat this? I think the "Some examples:" can just be put at the end of the previous paragraph, and then you can just eliminate the blank line after the list. It will read fine. :)

Also:

+   *   - tags this is the same as tags.value as value is the default column.

?!? This needs some punctuation or something? Probably a colon after tags: ?

chx’s picture

chx commented
StatusFileSize
new interdiff.txt934 bytes
new 2228711_5.patch2.28 KB
chx’s picture

chx commented
Status: Needs work » Needs review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Thanks, that looks better.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Committed to 8.x. Thanks for documenting!

  • Commit 441b3f3 on 8.x by jhodgdon: 
    Issue #2228711 by chx, plach, bojanz: Document entity query group...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.