restart.lisp

(uiop:define-package #:40ants-doc/locatives/restart
  (:use #:cl)
  (:import-from #:named-readtables)
  (:import-from #:pythonic-string-reader)
  (:import-from #:40ants-doc/locatives/define-definer
                #:define-definer-for-symbol-locative-type)
  (:import-from #:40ants-doc/locatives/definers
                #:define-symbol-locative-type))
(in-package #:40ants-doc/locatives/restart)

(named-readtables:in-readtable pythonic-string-reader:pythonic-string-syntax)


(define-symbol-locative-type restart ())


(define-definer-for-symbol-locative-type define-restart restart
  """A definer macro to hang the documentation of a restart on a
  symbol.

  ```
  (define-restart my-ignore-error ()
    "Available when MY-ERROR is signalled, MY-IGNORE-ERROR unsafely continues.")
  ```

  Note that while there is a CL:RESTART class, there is no
  corresponding source location or docstring like for CONDITIONs.
  """)