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

Lucius Cassius Comment syntax not documented #247

Open
BebeSparkelSparkel opened this issue Dec 18, 2019 · 5 comments
Open

Lucius Cassius Comment syntax not documented #247

BebeSparkelSparkel opened this issue Dec 18, 2019 · 5 comments

Comments

@BebeSparkelSparkel
Copy link

It would be nice to know the different comment syntax for Lucius and Cassius.

Standard css comments /* comment */ seems to work.

Is there any syntax that without comment close like --?

@psibi
Copy link
Member

psibi commented Dec 20, 2019

@BebeSparkelSparkel Would be interesting in creating a PR for this (and your other issues) ? Thanks!

@BebeSparkelSparkel
Copy link
Author

@psibi Yes, which file should I be editing?

@psibi
Copy link
Member

psibi commented Dec 20, 2019

@BebeSparkelSparkel You need to create Haddocks in the relevant modules for Lucius and Cassius with examples. For Lucius and Cassius, it has to be these files:

If you want to see an example project, where this is already done, you can see this haddock documentation: https://www.stackage.org/haddock/nightly-2019-12-20/persistent-2.10.4/Database-Persist.html
And the relevant haddock source: https://github.com/yesodweb/persistent/blob/master/persistent/Database/Persist.hs

@BebeSparkelSparkel
Copy link
Author

Thanks, I'll start reviewing these

@BebeSparkelSparkel
Copy link
Author

@psibi Actually, it seems like everything points to the yesod book. Would that be a better place to add these docs?

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

No branches or pull requests

2 participants