Bug #52503 MYSQL_FIELD description missing
Submitted: 31 Mar 2010 13:55 Modified: 6 Apr 2010 15:03
Reporter: Olaf van der Spek (Basic Quality Contributor) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version: OS:Any
Assigned to: Paul DuBois CPU Architecture:Any
Tags: qc

[31 Mar 2010 13:55] Olaf van der Spek
Description:
http://dev.mysql.com/doc/refman/5.0/en/c-api-datatypes.html

> This structure contains information about a field, such as the field's name, type, and size. Its members are described in more detail here.

Here? Where? I think a link is missing.

How to repeat:
-
[31 Mar 2010 14:11] Valeriy Kravchuk
Had you tried to read further on the same page, after the list of data types? I see the following there:

"The MYSQL_FIELD structure contains the members described in the following list:

    - char * name

      The name of the field, as a null-terminated string. If the field was given an alias with an AS clause, the value of name is the alias.
    - char * org_name

      The name of the field, as a null-terminated string. Aliases are ignored.
..."

So, I think "here" means on this very page, and description is NOT missing. It is right there.
[31 Mar 2010 14:15] Olaf van der Spek
Oops. Maybe 'here' should say 'below' instead?
[31 Mar 2010 14:25] Valeriy Kravchuk
Yes, "below" and/or link from it to some anchor further on the page will be useful.
[6 Apr 2010 15:03] Paul DuBois
Thank you for your bug report. This issue has been addressed in the documentation. The updated documentation will appear on our website shortly, and will be included in the next release of the relevant products.

Changed "here" to "later in this section." ("below" doesn't work well if the format is print output when the referenced stuff might be on the next page and thus not "below.")