CottageLabs / OpenArticleGauge

Software for the OpenArticleGauge service
http://www.howopenisit.org
Other
7 stars 5 forks source link

give sed example in plugin howto guide - removing tutorial comments #21

Open emanuil-tolev opened 11 years ago

emanuil-tolev commented 11 years ago

Right now the guide says:

"When you're done writing the plugin code, you can remove all comments which start with two hash signs (##), leaving the code cleaner and more readable. It can easily be done manually, or using regular expression such as ^\s##. (select everything starting with ##, regardless of indentation)."

This leaves tons of blank lines, although it does the job of removing the comments...

Give an example of how to actually delete the lines. Even include a small python script called "remove_tutorial_instructions.py" or something, if it would be easier for contributors. I'm leaning towards this, since windows ppl won't have sed without a Cygwin install.

Not very high priority obviously, since it might become less necessary with the addition of web form which would deprecate the simplistic string matching plugins.

emanuil-tolev commented 11 years ago

Actually, current regex seems to have removed all comments entirely from the Copernicus plugin... either that or the user used a different regex at the hack day which produced this plugin.