Main sheep package.
Use sheep to validate that documentation strings on external symbols adhere to a strict format and exist, so that they can be output to markdown format, while looking decent when used within a common lisp process.
export-package pkg => markdown
pkg---A package symbol markdown---A string containing the markdown representation of this packages documentation
export-package takes in pkg and converts all the documentation for the symbols into markdown with the hope of emulating the hyperspec style.
It should only be run after the package has been validated, as it assumes that all documentation it gets will be valid.
pretty-print-validate-packages &rest pkgs => success
pkgs::= pkg*
success---Whether or not all symbols passed validation pkg---A package symbol
pretty-print-validate-packages takes pkgs and runs validation on all of them. It dumps to standard out failures as it comes upon them, finally returning whether it was successful or not.
This can be used in validation tests to ensure that documentation can be generated at a later date.
(pretty-print-validate-packages :pkg1 :pkg2) => t
validate-package pkg => failures
failures::= failure* failure::= (:failure symb msg)
pkg---A package symbol symb---Symbol the check failed on msg---Message containing information about the failure
validate-package takes in pkg and validates that all the external symbols adhere to documentation guidelines, exist, and can be parsed to be used for exporting.
Only one error per symbol will be reported at a time, all concatenated to a list in the aforementioned form.
Used internally for sheep parts to signal a validation error.