shortdoc文档若以org来组织

大家有没感觉,如果shortdoc的格式若以org来组织,查询和使用使来会更方便?第一级说明api大体属于哪一类,第二级说明api名称,并且支持快速检索,第三层是api的具体例子。感觉这种大纲视角是非常符合api的查询思路的。

(不是所有的 emacser 都会 org

shortdoc 对包作者来说是很方便的东西,只需要填入示例代码就能生成非常简单的示例“文档”,对于单文件 package 来说文档和代码放在一起很省事

不过目前似乎除了一些 emacs 内置函数外没有多少包使用它

从用户角度来说,org-mode 还是太重了点,只看个文档就要加载一大堆不必要的模块不是很合适。而且 org 用户或多或少对 org-mode 有些 hack ,加上 org-mode 一直在更新,谁知道会有什么奇怪的 bug 。

是的,也许作者是考虑到普通格式更轻量,更易编写,所以避开了org

(我倒是认为一开始就没有考虑过 org

要弄清楚得问问作者或者翻邮件列表了