borkdude/quickdoc

toc descriptions can be incomplete sentences

ikappaki opened this issue · 0 comments

quickdock might generate incomplete sentences for the toc descriptions.

e.g. the babashka.process/sh generated entry below is an incomplete sentence

Table of contents

  • babashka.process - Shell out in Clojure with simplicity and ease.
    • $ - Convenience macro around process
    • *defaults* - Dynamic var containing overridable default options
    • check - Takes a process, waits until is finished and throws if exit code is non-zero.
    • destroy - Takes process or map
    • destroy-tree - Same as destroy but also destroys all descendants
    • exec - Replaces the current process image with the process image specified
    • pb - Returns a process builder (as record).
    • pipeline - Returns the processes for one pipe created with -> or creates
    • process - Takes a command (vector of strings or objects that will be turned
    • sh - Convenience function similar to clojure.java.shell/sh that sets
    • shell - Convenience function around process that was originally in babashka.tasks.
    • start - Takes a process builder, calls start and returns a process (as record).
    • tokenize - Tokenize string to list of individual space separated arguments.

This is because the description looks only at the first line of the dosctring. A possible solution could be to extract the text up to the first full stop, thus sh's toc description would become

Convenience function similar to `clojure.java.shell/sh` that sets `:out` and `:err` to `:string` by default and blocks.