Format of documentation

This commit is contained in:
Simon Brooke 2022-12-21 17:39:50 +00:00
parent 25795cf364
commit 2df7b6563d
2 changed files with 19 additions and 6 deletions

File diff suppressed because one or more lines are too long

View file

@ -1,10 +1,12 @@
(ns dog-and-duck.quack.picky "Fault-finder for ActivityPub documents. (ns dog-and-duck.quack.picky "Fault-finder for ActivityPub documents.
Generally, each `-faults` function will return: Generally, each `-faults` function will return:
1. `nil` if no faults were found; 1. `nil` if no faults were found;
2. a sequence of fault objects if faults were found. 2. a sequence of fault objects if faults were found.
Each fault object shall have the properties: Each fault object shall have the properties:
1. `:@context` whose value shall be the URL of a 1. `:@context` whose value shall be the URL of a
document specifying this vocabulary; document specifying this vocabulary;
2. `:type` whose value shall be `Fault`; 2. `:type` whose value shall be `Fault`;