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 761139 - python unicode docstrings are ignored
python unicode docstrings are ignored
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.8
Other Windows
: Normal major
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2016-01-26 15:48 UTC by Anders Munch
Modified: 2016-09-05 13:46 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Reproducing example. (26.52 KB, application/x-zip-compressed)
2016-01-27 14:26 UTC, Anders Munch
Details

Description Anders Munch 2016-01-26 15:48:28 UTC
Module, class and function docstrings in Python code are completely ignored if they are of the unicode variety with a u prefix.

It looks like raw strings (with an r prefix) are also ignored.
Comment 1 albert 2016-01-26 18:46:12 UTC
Can you please attach a self-contained example (source+config file in a tar or zip) that allows us to reproduce the problem?
Comment 2 Anders Munch 2016-01-27 14:26:22 UTC
Created attachment 319836 [details]
Reproducing example.

I included function examples for all prefix combinations, but in general practise only the lower-case u is used.
There's a snip og accented text in the unicode variations, so you can use it as a test case and check that the accented words are correctly encoded in the docs. That's assuming Doxygen interprets the encoding comment, which would be the proper thing to do.

The included Doxyfile is just a default-generated configuration. It doesn't look like any of the configuration options make a difference.
Comment 3 albert 2016-01-27 15:44:02 UTC
I have just pushed a proposed patch to github (pull request 448)
Comment 4 albert 2016-02-03 10:16:17 UTC
Code has been integrated in github
Comment 5 Dimitri van Heesch 2016-09-05 13:46:32 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.12. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information 
that you think can be relevant (preferably in the form of a self-contained example).