i wondered that. looks like markdown link-w/o-the-reference-id syntax. (is supported by docudown?) but then, it's not clear were it finds it's definition. (work-in- progress?)
which brings up larger questions. as i was writing docstrings for de.setf.amqp, i wondered, while markdown is most definitely less obnoxious than html, why does a lisp documentation system require markup in its docstrings? when the documentation is processed, a closed world can be arranged.
the documentation generation code - as i've read and written it, crawls packages and/or live images, so there's a lot it can do without the markup hints. given that information, it is possible to recognize almost every pertinent reference without the hints in terms of bindings on symbols present in every package reachable from the respective function definition minus common-lisp.
?
On 2010-02-24, at 15:02 , Robert Goldman wrote:
On 2/24/10 Feb 24 -5:54 AM, Tobias C. Rittweiler wrote:
Although the way to extend operations by additional initargs is somewhat cumbersome, it's possible. Unfortunately, the sugar forms LOAD- SYSTEM, COMPILE-SYSTEM, and TEST-SYSTEM do not take additional initargs.
I see that the docstrings for these functions seem to have some form of markup in them that I do not recognize ( [operate][] ). Can you comment on this?
best, r
-T.
diff --git a/asdf.lisp b/asdf.lisp index 92e7f6e..3f230d5 100644 --- a/asdf.lisp +++ b/asdf.lisp @@ -1670,18 +1670,24 @@ created with the same initargs as the original one. (setf (documentation 'operate 'function) operate-docstring))
-(defun load-system (system &rest args &key force (verbose t) version)
- "Shorthand for `(operate 'asdf:load-op system)`. See [operate]
[] for details." +(defun load-system (system &rest args &key force (verbose t) version
&allow-other-keys)- "Shorthand for `(operate 'asdf:load-op system)`. See [operate]
[] for +details." (declare (ignore force verbose version)) (apply #'operate 'load-op system args))
-(defun compile-system (system &rest args &key force (verbose t) version)
- "Shorthand for `(operate 'asdf:compile-op system)`. See
[operate][] for details." +(defun compile-system (system &rest args &key force (verbose t) version
&allow-other-keys)- "Shorthand for `(operate 'asdf:compile-op system)`. See
[operate][] +for details." (declare (ignore force verbose version)) (apply #'operate 'compile-op system args))
-(defun test-system (system &rest args &key force (verbose t) version)
- "Shorthand for `(operate 'asdf:test-op system)`. See [operate]
[] for details." +(defun test-system (system &rest args &key force (verbose t) version
&allow-other-keys)- "Shorthand for `(operate 'asdf:test-op system)`. See [operate]
[] for +details." (declare (ignore force verbose version)) (apply #'operate 'test-op system args))
asdf-devel mailing list asdf-devel@common-lisp.net http://common-lisp.net/cgi-bin/mailman/listinfo/asdf-devel
asdf-devel mailing list asdf-devel@common-lisp.net http://common-lisp.net/cgi-bin/mailman/listinfo/asdf-devel