quickdoc
quickdoc copied to clipboard
toc descriptions can be incomplete sentences
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 aroundprocess*defaults*- Dynamic var containing overridable default optionscheck- Takes a process, waits until is finished and throws if exit code is non-zero.destroy- Takes process or mapdestroy-tree- Same asdestroybut also destroys all descendantsexec- Replaces the current process image with the process image specifiedpb- Returns a process builder (as record).pipeline- Returns the processes for one pipe created with -> or createsprocess- Takes a command (vector of strings or objects that will be turnedsh- Convenience function similar toclojure.java.shell/shthat setsshell- Convenience function aroundprocessthat was originally inbabashka.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.