kwan888-github / iep

Automatically exported from code.google.com/p/iep
0 stars 0 forks source link

TODO comments colouring misleading #217

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
TODO comments get coloured pink in the editor immediately upon writing "# 
TODO", however are only displayed in the Source Structure once a colon is added 
(ie "# TODO:"). This behaviour is inconsistent and somewhat misleading.

Expected behaviour: Editor colouring moment and Source Structure display moment 
should be the same - either upon typing TODO or upon typing TODO:, according to 
convention.
Suggested convention: Google Python Style Guide: "A colon is optional."
Improvement on convention: To prevent user errors IEP should continue to 
acknowledge TODO comments whether they were written in all caps or not.

https://google-styleguide.googlecode.com/svn/trunk/pyguide.html?showone=TODO_Com
ments#TODO_Comments

Original issue reported on code.google.com by zaha...@gmail.com on 26 Mar 2013 at 2:54

GoogleCodeExporter commented 8 years ago
There is indeed a mismatch between syntax highligter and source structure, 
because they are parsed separately (and in different ways). 

After the overhaul of syntax highlighting we want to do the source structure 
parsing together with syntax highlighting, which will get rid of this 
inconsistency (and others too).

Original comment by almar.klein@gmail.com on 27 Mar 2013 at 9:08

GoogleCodeExporter commented 8 years ago
As part of migrating our code repositories from Googlecode
to Bitbucket, all IEP issues are now tracked at 
https://bitbucket.org/iep-project/iep/issues

To view this issue, use this link (with X replaced by the issue number):
https://bitbucket.org/iep-project/iep/issue/X

Issues on Bitbucket can be created by anyone. Commenting on issues requires 
login via Bitbucket, Google, Twitter or Github.

Original comment by almar.klein@gmail.com on 11 Jun 2013 at 2:40