doc, docstring pass, public api - Githubissues

clj-commons / clj-yaml

YAML encoding and decoding for Clojure

Other

120 stars 25 forks source link

doc, docstring pass, public api #68

Closed lread closed 2 years ago

lread commented 2 years ago

Review and update docs and docstrings. While doing so answered the question of what the public API is.

Of note:

split out user and developer guides from README
review and update docstrings
sway users to use what we consider the high-level API, but support all of the current clj-yaml.core
describe :unsafe option (added unit tests while working to understand)
describe :mark option

Closes #65, Closes #66

borkdude commented 2 years ago

Nice work!