After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 568485 - typewriting error in Gtk::AccelMap::add_entry(..) reference
typewriting error in Gtk::AccelMap::add_entry(..) reference
Status: RESOLVED FIXED
Product: gtkmm
Classification: Bindings
Component: reference documentation
unspecified
Other Linux
: Normal trivial
: ---
Assigned To: gtkmm-forge
gtkmm-forge
: 568486 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2009-01-20 21:27 UTC by Mihai Niculescu
Modified: 2009-02-05 17:51 UTC
See Also:
GNOME target: ---
GNOME version: 2.23/2.24


Description Mihai Niculescu 2009-01-20 21:27:37 UTC 
Gtk::AccelMap::add_entry(..) displays a minor error in the description. The html entities &lt; and &gt;  are shown instead of < and >

It displays: [...] consist of "& lt;WINDOWTYPE& gt;/Cat[...]
instead of [...] consist of "<WINDOWTYPE>/Cat[...]
Same for: [...] may look like: "& lt;Gimp-Toolbox& gt;/F[...]
Comment 1 Murray Cumming 2009-01-22 16:13:51 UTC 
Confirmed.
http://www.gtkmm.org/docs/gtkmm-2.4/docs/reference/html/namespaceGtk_1_1AccelMap.html#6313a0f99aebe342c08f2d2d0f9416ad

Maybe we can fix this in our perl script.
Comment 2 Murray Cumming 2009-01-22 16:15:29 UTC 
*** Bug 568486 has been marked as a duplicate of this bug. ***
Comment 3 Murray Cumming 2009-01-27 09:36:30 UTC 
CCing Daniel, who might be interested in fixing this, if he has time.
Comment 4 Daniel Elstner 2009-01-27 16:28:06 UTC 
It turns out that the mistaken escape was caused by the docextract_to_xml.py script in the pygobject module.  As it is currently only used by gtkmm anyway, I took the liberty of committing a fix to pygobject trunk:

2009-01-27  Daniel Elstner  <danielk@openismus.com>

	* codegen/docextract_to_xml.py (escape_text): Do not escape the
	ampersand "&" in entity references (bug #568485).  Replace some
	unusual entity references in the output with their literal values.

Note that the change might also affect other uses of entity references in the documentation, not necessarily for the better.  It's hard to get it right in all cases if you have to guess the intended meaning...
Comment 5 Murray Cumming 2009-02-05 17:51:48 UTC 
Actually this particular documentation was in the non-generated accelmap.h file. I corrected it there.

Hopefully the fix in docextract_to_xml.py fix has corrected it in other places too.