sym-set-doc: fix trim-indent

Find the least indented line instead of just using the second one. Also encourage using verbatim strings («») in docstrings.

Sigrid Solveig Haflínudóttir committed 4 months ago

Commit ee261ec1 parent 1c8976d3 files · +54 −59Browse files

Showing the changes to src (2 of 3 files). Show all

Unified · Split

2 files

src/docs.sl +6 −6
src/system.sl +10 −14

src/docs.sl+6−6

@@ -19,16 +19,16 @@ · 18 unmodified lines
19	by `defstruct` to provide full constructor description in the output.»	19	by `defstruct` to provide full constructor description in the output.»
20	:doc-example	20	:doc-example
21	«(defdoc (func arg (arg2 0))	21	«(defdoc (func arg (arg2 0))
22	"Return something about the `arg` and `arg2`. This is a short	22	«Return something about the `arg` and `arg2`. This is a short
23	description.	23	description.
24		24
25	This is the longer description, following the short one."	25	This is the longer description, following the short one.\»
26	:doc-example	26	:doc-example
27	"(func 0)	27	«(func 0)
28	; ↳ T"	28	; ↳ T\»
29	:doc-example	29	:doc-example
30	"(func 1 3)	30	«(func 1 3)
31	; ↳ NIL"	31	; ↳ NIL\»
32	:doc-group stuff	32	:doc-group stuff
33	:doc-see func2	33	:doc-see func2
34	:doc-fmt (λ (doc) doc)	34	:doc-fmt (λ (doc) doc)

src/system.sl+10−14

     (let* {[lines (str-split s "\n")]
            [hd (car lines)]
            [tl (cdr lines)]
-           [snd (any (λ (s) (and (> (length s) 0)
+           [indent (and tl (apply min (map (λ (s) (and (> (length s) 0)
-                                 (rune-whitespace? (str-rune s 0))
+                                                       (- (length s) (length (str-trim s)))))
-                                 s))
+                                           tl)))]
-                     tl)]
+           [trimmed (and tl
-           [indent (and snd
-                        (- (length snd)
-                           (length (str-trim snd))))]
-           [trimmed (and snd
                          (map (λ (s) (if (<= indent (length s))
                                          (str-sub s indent)
                                          s))
   «Define a new macro.»
   :doc-example
   «(defmacro (inc! v)
-     "Increments and returns the value."
+     «Increments and returns the value.\»
      :doc-group my-cool-macros
      :doc-see my-other-cool-macro
      (if (num? v)
   :doc-example
   «; a function with documentation (first form)
    (def (f x)
-     "Return the square of doubled `x`."
+     «Return the square of doubled `x`.\»
      :doc-example
-     "(f 3)
+     «(f 3)
-      ; ↳ 36"
+      ; ↳ 36\»
      :doc-group cool-funcs ; documentation group for (help groups)
      :doc-see g ; reference another function in the documentation
      (def (g y) ; an internal function
    If no `else` was specified and no matches occured, `NIL` is
    returned.»
   :doc-example
-  «(case 'c      ; match present
+  «(case 'c ; match present
      (a 0)
      ((b c d) 1))
    ; ↳ b»
            (newline))
    ; ‼ yay»
   :doc-example
-  «(case "c"     ; no matches, without else
+  «(case "c" ; no matches, without else
      ("a" 0)
      ("b" 1))
    ; ↳ NIL»

sym-set-doc: fix trim-indent

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code