[wp-trac] [WordPress Trac] #6362: Inline documentation introduced in 2.5

WordPress Trac wp-trac at lists.automattic.com
Sun Mar 23 10:22:43 GMT 2008


#6362: Inline documentation introduced in 2.5
-------------------------------+--------------------------------------------
 Reporter:  RanYanivHartstein  |       Owner:  anonymous
     Type:  defect             |      Status:  new      
 Priority:  normal             |   Milestone:  2.5      
Component:  Administration     |     Version:           
 Severity:  normal             |    Keywords:           
-------------------------------+--------------------------------------------
 2.5 introduced inline documentation in the administration areas - many
 options now have short descriptions.

 However, some of these could be made superfluous if only the options they
 were documenting were properly explained in the first place.

 For e.g., in the post edit page, the option for allowing pingbacks and
 trackbacks reads "Allow pings", and is followed by and explanation that
 reads "pings are trackbacks and pingbacks". Isn't it easier to just say
 "Allow trackbacks and pingbacks", and this way be more consistent with
 other mentions of these concepts elsewhere in the admin?

 A more obvious example is in the link edit page. Options for setting the
 target value are just the meaningless "_blank", "_top" and "none", and
 these are followed by an explanation that reads "Essentially this means if
 you choose _blank your link will open in a new window" (i.e., "We confused
 you with too many options you don't care about, but this is how to get
 what you really want here"). I would suggest simply explaining what these
 options do - "_blank (new window/tab)", "_top (breaks out of frames),
 "none (same window)".

 I suppose there are more examples, these are just a few that stood out.

-- 
Ticket URL: <http://trac.wordpress.org/ticket/6362>
WordPress Trac <http://trac.wordpress.org/>
WordPress blogging software


More information about the wp-trac mailing list