Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
15 Feb 2013 at 15:39 UTC
Updated:
29 Jul 2014 at 21:54 UTC
Jump to comment: Most recent file
Comments
Comment #1
dawehner.
Comment #2
jhodgdonThanks! A few things to fix:
- Needs newline between @param and @return sections.
- SQL is an acronym and needs to be all-caps in documentation. Actually though, I think rather than calling it a "sql field" (I had to think quite a while before I figured out what that meant), maybe this documentation should refer to constructing a database table field alias or something like that? I just thought that this phrase:
"a sql field for a given field"
was confusing, given that the word "field" has two meanings only a couple of words apart.
Comment #3
dawehnerThanks for the feedback. Yeah I was uncomfortable with that as well.
What do you think about this, is this easier to understand?
Comment #4
jhodgdonMuch better, thanks! I still don't really understand the return value documentation though:
An expression of the field and language, so for example "base_table.id".
Maybe something more like this would be clearer?
An expression that will select the given field for the given language in a SELECT query, such as 'base_table.id'.
Comment #5
dawehnerOh much much better!!
Comment #6
jhodgdonGlad we agree on the wording. One more thing: indent two spaces instead of one on @return docs.
Comment #7
dawehnerOh damn :) I'm feeling a bit like a novice starting the first contribution.
Comment #8
jhodgdonLooks good -- I'll get it committed soon (may need to wait for some Avoid Commit Conflicts issues first, but sometime soon). Thanks!
Comment #9
jhodgdonThis didn't conflict after all, so I committed it. Thanks again!