Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow documenting SassDoc comments. #519

Open
jgerigmeyer opened this issue Dec 5, 2017 · 4 comments
Open

Allow documenting SassDoc comments. #519

jgerigmeyer opened this issue Dec 5, 2017 · 4 comments

Comments

@jgerigmeyer
Copy link
Contributor

jgerigmeyer commented Dec 5, 2017

This is related to #428 -- and really stems from CDocParser, used by scss-comment-parser, (see issued filed there: FWeinb/CDocParser#16) -- but relates to a SassDoc use-case, so I wanted to document it here as well.

Within a SassDoc comment, I would like to document how to make a SassDoc comment. For example:

/// Here is how to add a comment:
/// /// I am a comment.

Right now, CDocParser strips to to just:

Here is how to add a comment:
I am a comment.

Instead of the desired:

Here is how to add a comment:
/// I am a comment.

Is there a good way to do this? Could there be an option to mark a section of text as "escaped", so it won't be parsed as a comment? Or enforce only one comment per line?

@jgerigmeyer
Copy link
Contributor Author

I think I've found a way to address this in CDocParser without breaking other use-cases: FWeinb/CDocParser#17

@steffenpedersen
Copy link

Hi @jgerigmeyer, is this still an issue? I can see, that you made some changes in CDocParser 😃

@jgerigmeyer
Copy link
Contributor Author

@steffenpedersen Well, sort of and also not really. :)

It's been fixed in CDocParser v0.15.0, but SassDoc (through scss-comment-parser) is still using the older v0.13.0, where this is not fixed. I don't fully understand why (I've been using SassDoc with CDocParser v0.15.0 for nearly a year without issue), but see @pascalduez's comment: FWeinb/CDocParser#16 (comment)

@pascalduez
Copy link
Member

Because 0.14 enables a new feature that we would prefer to get documented and unit tested. Otherwise it might get lost in limbo :) Will try to find some time to get this done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants