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

complete haddock comments with examples for Citeproc and Citeproc.Types #67

Open
andrewufrank opened this issue May 7, 2021 · 0 comments

Comments

@andrewufrank
Copy link

Congratulation for the new citeproc package!

I tried to read the documentation to understand how to use it in building webpages from markdown files. I am not a pandoc or bibtex specialist (my interest is spatial ontologies) and had difficulties to see what the functions do, because the terms you use are (for me) polysemous and it is difficult to grasp what you intend. The solution is simple: add an example and things become clear at once (works mostly...).

Practically: could you add a simple example in the haddock comments for the top classes, as you did for data Citation a in http://hackage.haskell.org/package/citeproc-0.3.0.9/docs/Citeproc-Types.html#t:Citation. I think this is easy to do and would help a lot to clarify how to use the new modules.

Thank you for inventing pandoc and keeping it!

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

1 participant