Fix find-plans and find-plans-stack docstrings for translation to Texinfo

[rpgoldman]

Use Markdown-style *'s for lists of parameters, so that sb-texinfo does a better job of translation. Even better would be to do something like Numpy-style docstrings that are readable as text or can be translated to good-looking Texinfo.

[ko56]

How about the documentation of find-plans-stack? Is there anything there that can be improved? I'd also be interested in experimenting with it, if you consider it in a usable state.

[rpgoldman]

find-plans-stack could use the same improvement. Checking the code, sb-texinfo claims to handle itemized lists if lines begin with a *. So that is worth a try.

Feel free to use find-plans-stack. It does not offer all of the different :which options that find-plans does, but for :which :first it is more efficient than find-plans.

[ko56]

I just noticed this in explicit-search.lisp:

(defun find-plans-stack (problem &key domain (verbose 0) plan-tree (gc *gc*)
                                   (no-dependencies nil)
                                   repairable
                                   rationale
                                   (state-type :mixed state-type-supplied-p)
                                   (out-stream t)
                                   (which :first)
                                   analogical-replay
                                   (unpack-returns t)
                                   make-analogy-table)
  "Top level search function for explicit-state search in SHOP3.
Does not support the full range of options supported by SHOP3's
`find-plans-stack`.

Note the "find-plans-stack" in both the first and last lines. This also causes a problem in the manual.

[rpgoldman]

Good catch! Thanks.

[rpgoldman]

I’m not sure whether sb-texinfo does cross-references. There’s not a ton of documentation. I’ll look at the code