Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Major
Category:
Bug report
Assigned:
Unassigned
Reporter:
Created:
8 Feb 2014 at 15:04 UTC
Updated:
29 Jul 2014 at 23:21 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonAlso I think there are some old "Implements..." documented methods in this file that should be converted to inheritdoc.
Comment #2
divesh.kumar commentedI have changed the documentation for it.
Comment #3
longwaveComment #4
jhodgdonThanks for the patch!
A class (or anything else) needs a one-line summary to start its documentation.
And for a class, this should start with a verb. We have standards on how to write documentation -- see
https://drupal.org/coding-standards/docs#classes
and this general section:
https://drupal.org/coding-standards/docs#drupal
The rest of the patch looks good.
Comment #5
divesh.kumar commentedI have made changes as suggested.
Comment #6
divesh.kumar commentedComment #7
jhodgdonOops, the one-line documentation intended for the class got into a method instead.
I also have a suggestion for the one-line class documentation... How about:
Implements entity query conditions for SQL databases.
(This is a class specifically for entity query conditions, and I think we need to get that into the documentation.)
Comment #8
divesh.kumar commentedMy bad!!! Made changes in the new patch..
Comment #10
divesh.kumar commentedComment #12
divesh.kumar commentedPatch is failing due to LocalePluralFormatTest.php.
Comment #13
longwave10: 2191721-4.patch queued for re-testing.
Comment #15
jhodgdonThanks! Test failure is unrelated, and I don't think we need to hit "retest" as it's some "table not found" glitch in the test bot on one test. The patch looks good.
Comment #16
catchCommitted/pushed to 8.x, thanks!