Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
20 May 2013 at 16:29 UTC
Updated:
13 Feb 2014 at 17:20 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonOK, I had some more time today to investigate this.
The doc block currently says:
This is actually correct. The only problems are that it doesn't format as three separate lines, and the @see lines shouldn't end in ".".
Probably we should just make this into a list, which will format them on separate lines. Good Novice project?
http://drupal.org/node/1354#lists
Comment #2
sarahdavies commentedI'm at DrupalCon and this is my first attempt to contribute. Please let me know if I did okay!
Comment #3
phl3tch commentedWorks like a charm.
Comment #4
jhodgdonThanks! Can you remove the blank line between the line ending in : and the start of the list? See http://drupal.org/node/1354#lists
Comment #5
sarahdavies commentedHere you go.
Comment #7
jhodgdon#5: drupal-form-builder-formatting-1999074-5.patch queued for re-testing.
Comment #8
jhodgdonThat looks good! Oh, but I just noticed one other thing. The "End of defgroup forms" needs to be removed. You can see it on this page:
http://api.drupal.org/api/drupal/core!includes!form.inc/group/forms/8
The syntax is:
http://drupal.org/node/1354#defgroup
(syntax example 1 -- we only put "end of defgroup whatever" if there are functions between the end of the documentation block and the @} -- which is not the case here).
Comment #9
sarahdavies commentedGood catch!
Comment #10
jhodgdonLooks good, thanks! I'll get that committed shortly unless someone else is hanging out at the sprint making commits. :)
Comment #11
jhodgdonThanks again! Committed to 8.x.
The patch will not apply to 7.x, so it needs to be ported.
Comment #12
adam_ commentedI'm going to try to tackle this for sprint weekend as a first project, has anyone started on it?
Comment #13
adam_ commentedI looked up the list syntax in the documentation: https://drupal.org/node/1354#lists and added the code to a list, the text to be removed was no longer present.
Comment #14
jhodgdonLooks good, thanks!
Comment #15
jhodgdonThanks again everyone! Committed to 7.x.