Documentation is terrible and too much stuff is annotated "shared"

CPColin / ceylon.markdown

A port of the commonmark.js Markdown parser and renderer to Ceylon

Apache License 2.0

5 stars 0 forks source link

Documentation is terrible and too much stuff is annotated "shared" #22

Closed CPColin closed 6 years ago

CPColin commented 6 years ago

When I uploaded the module to the Herd, ceylon doc rightfully warned me about a bunch of places where I missed adding documentation. I'm also embarrassed to look at the README, which doesn't even have an example usage in it! Time to do some writing! Along the way, double-check that stuff annotated shared actually needs to be.

CPColin commented 6 years ago

Settled for fixing the shared annotations and the README, for now. I don't want to release version 1.0.1 this soon, so the README is more important than adding additional Ceylon comments. Will make sure all the options are documented in the source, now, though.