Python: fix escapes in quoted-comments
ClosedPublic
Actions

Authored by nibags on Jul 12 2018, 6:46 AM.

Details

Reviewers

dhaumann
cullmann

Group Reviewers

Framework: Syntax Highlighting
Kate

Commits

R216:2627d3e421f6: Python: fix escapes in quoted-comments

Summary

BUG: 386685

Escape characters are not detected in triple-quote comments.
Comments in quotes are literal strings that do not have assignment or operations, so the interpreter ignores them. These are also used to associate documentation with objects, using the __doc__ attribute (Docstrings [1][2]).

Comments in quotes support the same escapes as normal string. Also, since these can be used as documentation strings, I believe that the correct way is to use the same string escape highlight.

[1] Python. PEP 257 -- Docstring Conventions: https://www.python.org/dev/peps/pep-0257/
[2] Python docstrings: http://www.pythonforbeginners.com/basics/python-docstrings

Diff Detail

Repository

R216 Syntax Highlighting

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

nibags created this revision.Jul 12 2018, 6:46 AM

Restricted Application added projects: Kate, Frameworks. · View Herald TranscriptJul 12 2018, 6:46 AM

Restricted Application added subscribers: kde-frameworks-devel, kwrite-devel. · View Herald Transcript

Harbormaster completed remote builds in B773: Diff 37615.Jul 12 2018, 6:46 AM

nibags requested review of this revision.Jul 12 2018, 6:46 AM

nibags added a reviewer: Framework: Syntax Highlighting.Jul 12 2018, 6:49 AM

Please change Bug #386685: https://bugs.kde.org/show_bug.cgi?id=386685 to BUG: 386685. See https://community.kde.org/Infrastructure/Phabricator#Add_special_keywords

Can you add a test line to autotests/input/test.py ?

nibags edited the summary of this revision. (Show Details)Jul 13 2018, 3:52 AM

Add test.

I also included a missing MIME type, obtained from shared-mime-info.

Harbormaster completed remote builds in B826: Diff 37722.Jul 14 2018, 3:45 AM

Thanks! Looks good to me.

This revision is now accepted and ready to land.Jul 14 2018, 8:25 AM

Closed by commit R216:2627d3e421f6: Python: fix escapes in quoted-comments (authored by nibags, committed by dhaumann). · Explain WhyJul 14 2018, 11:13 AM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			autotests/folding/test.py.fold (5 lines)
M			autotests/html/test.py.html (5 lines)
M			autotests/input/test.py (5 lines)
M			autotests/reference/test.py.ref (5 lines)
M			data/syntax/python.xml (9 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	37615	44bc7c6		Jul 12 2018, 6:46 AM	★	★
Diff 2	37722	44bc7c6	- Add test.	Jul 14 2018, 3:45 AM	★	★
Diff 3	37737	44bc7c6	R216:2627d3e421f6e5973258688c50a1391988500cac	Jul 14 2018, 11:11 AM	★	★

Commit	Tree	Parents	Author	Summary	Date
7fc9a87d5391	d70637199f36	b3d68e6b59e6	Nibaldo González	Add test & missing MIME type.	Jul 14 2018, 3:39 AM
b3d68e6b59e6	5175b743995e	44bc7c609dad	Nibaldo González	Python: fix escapes in quoted-comments (Show More…)	Jul 12 2018, 6:37 AM