search

whitequark / Sublime-S-Expressions

Sublime Text 3 syntax definition for S-Expressions
BSD Zero Clause License
2 stars 0 forks source link

Question about the comments style. #2

Closed leoheck closed 3 years ago

leoheck commented 3 years ago

Hello @whitequark, I am using this plugin for the first time and I have this question.

I am using a tool called Kicad that is used to make PCBs, The next version of the tool is going to uses S-Expressions. It is currently being developed.

They are commenting out blocks with the "#" character but this plugin does not highlight these blocks as commnets. So, I have a question. Are they using the wrong way to comment on s-expressions or this plugin is not highlighting this type of comments but it should have been doing this?

Check this example: image

whitequark commented 3 years ago

Are they using the wrong way to comment on s-expressions or this plugin is not highlighting this type of comments but it should have been doing this?

Neither. There is no single concrete "S expression" syntax, and no single way to represent comments. I think you should copy the definitions in this plugin, rename it to something like "Kicad S Expressions" and alter the syntax definitions to match what Kicad does. (I am answering your question as someone who has used Kicad and is aware of the specific format it uses.)

leoheck commented 3 years ago

Cool. What do you think about adding this here? It is just a matter of marking as comment, lines that starts with #.

whitequark commented 3 years ago

I already explained in the previous comment that I don't think it's appropriate to extend this package to handle Kicad.

leoheck commented 3 years ago

Sure, I am not talking about Kicad. Kicad was just an example. I am talking about comments that start with #

-- Leandro Heck

On Mon, Mar 1, 2021 at 1:28 AM whitequark notifications@github.com wrote:

Closed #2 https://github.com/whitequark/Sublime-S-Expressions/issues/2.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/whitequark/Sublime-S-Expressions/issues/2#event-4387223718, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJX7YD65SVCEZD7ZP73223TBMJXBANCNFSM4YKGHQEQ .

leoheck commented 3 years ago

For instance, Readme states that

Line comments
; hello;

It could be

Line comments
; hello;
# hello;