Bug 20180

Summary:	There are misprints in the spec for "Base class for font faces" and "How a font should be rendered" groups
Product:	cairo	Reporter:	Truc Truong <tructv>
Component:	general	Assignee:	Carl Worth <cworth>
Status:	RESOLVED FIXED	QA Contact:	cairo-bugs mailing list <cairo-bugs>
Severity:	minor
Priority:	medium	CC:	huyentht
Version:	1.8.6
Hardware:	All
OS:	All
Whiteboard:
i915 platform:		i915 features:

Description Truc Truong 2009-02-18 01:05:09 UTC

There are misprints in the spec. They are no harm, but if they are fixed, it will raise the quality of cairo documentation a notch higher.

- In the spec for cairo_font_options_destroy(), the standard states:
"Destroys a cairo_font_options_t object created with with cairo_font_options_create() or cairo_font_options_copy()."

Remove the extra text as follows:
"Destroys a cairo_font_options_t object created with  cairo_font_options_create() or cairo_font_options_copy()."

- In the spec for cairo_font_options_hash(), the standard states:
"Compute a hash for the font options object;"

Add the character as follows:
"Computes a hash for the font options object;"

- In the spec for cairo_subpixel_order_t, the standard states:
"CAIRO_SUBPIXEL_ORDER_DEFAULT 
Use the default subpixel order for for the target device"

Remove the extra text as follows:
"CAIRO_SUBPIXEL_ORDER_DEFAULT
Use the default subpixel order for the target device"

- In the spec for cairo_font_face_get_user_data(), the standard states:
"Return user data previously attached to font_face using the specified key. If no user data has been attached with the given key this function returns NULL."

Add the character as follows:
"Returns user data previously attached to font_face using the specified key. If no user data has been attached with the given key this function returns NULL."

- In the spec for cairo_font_face_set_user_data(), the standard states:
"Attach user data to font_face. To remove user data from a font face, call this function with the key that was used to set it and NULL for data."

Add the character as follows:
"Attachs user data to font_face. To remove user data from a font face, call this function with the key that was used to set it and NULL for data."

Please, give us your decision.

Thank you very much for your time.

Comment 1 Chris Wilson 2009-06-03 02:48:21 UTC

(In reply to comment #0)
> There are misprints in the spec. They are no harm, but if they are fixed, it
> will raise the quality of cairo documentation a notch higher.
> 
> - In the spec for cairo_font_options_destroy(), the standard states:
> "Destroys a cairo_font_options_t object created with with
> cairo_font_options_create() or cairo_font_options_copy()."
> 
> Remove the extra text as follows:
> "Destroys a cairo_font_options_t object created with 
> cairo_font_options_create() or cairo_font_options_copy()."

Duplicate 'with' removed.
> 
> - In the spec for cairo_font_options_hash(), the standard states:
> "Compute a hash for the font options object;"
> 
> Add the character as follows:
> "Computes a hash for the font options object;"

I don't prefer one form over the other...

Comment 2 huyentht 2009-07-01 21:18:08 UTC

Mr Truc Truong write:
>...
> - In the spec for cairo_subpixel_order_t, the standard states:
> "CAIRO_SUBPIXEL_ORDER_DEFAULT 
> Use the default subpixel order for for the target device"
> 
> Remove the extra text as follows:
> "CAIRO_SUBPIXEL_ORDER_DEFAULT
> Use the default subpixel order for the target device"
>...

It's duplicate 'for'.
Please, give us your decision.

Thank you very much for your time.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.