Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
12 Oct 2012 at 16:42 UTC
Updated:
24 Mar 2015 at 11:34 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #0.0
lars toomre commentedUpdated issue summary.
Comment #1
mile23Comment #2
mile23Comment #3
Katiemouse commentedHi I am in high school and very new to drupal. I have attempted a patch and have attached it :)
Comment #4
jhodgdonThanks for the patch and welcome to Drupal!
This looks pretty good. I'm not sure if it fixes all the problems in dblog, but someone else can check it.
One problem: In text, "id" is a Freudian term (ego, superego, id), so it shouldn't be used in documentation. "ID" is what you want to use in Drupal docs (means "identifier" or "identification").
So even though the parameter name is $id (which is right), the text should say "The ID of the ...".
Comment #5
mile23Actually it *does* get all the type hinting errors, according to phpcs. :-)
So all it needs is the change from #4, and it's RTBC.
Comment #6
Katiemouse commentedHi all, thanks for the help and advice. I think I've managed to fix that last bit :)
Comment #7
Katiemouse commentedHi all, thanks for the help and advice. I think I've managed to fix that last bit :)
Comment #8
mile23Oh I spoke too soon... There's this, in
DbLogController:Should be
objectinstead ofstdclass, but really should be whatever interface of object is actually expected.I think just substituting
objectwill be good, because it documents the behavior of the method, but if you find some documentation for a more specific type by all means add that.Thanks.
Comment #9
Katiemouse commentedHi, I changed that last part to object as you suggested :)
Comment #10
mile23That catches the last one. Thanks for sticking with it!
Comment #11
jhodgdonThe patch has unrelated stuff in it.
Comment #12
Katiemouse commentedHi, sorry what was the unrelated part of the patch?
Comment #13
jhodgdonClick on the file link above. https://www.drupal.org/files/issues/1811242-9-stdclass-object-corrected....
It has a bunch of stuff that is completely unrelated to adding DBLog module doc blocks in it. Looks like maybe it is the patch for a different issue?
Comment #14
mrjmd commentedHere's a roll of the fix from #9 without the unrelated stuff in it.
Comment #15
mile23Comment #16
jhodgdonThe latest patch looks fine. I haven't checked to see if it contains all needed param/return fixes in dblog.module, but it is certainly fine to commit as it is. Thanks!
Comment #17
alexpottCommitted 1abfba4 and pushed to 8.0.x. Thanks!