product.el (Re: DEL and SPC in RMAIL-summary buffer)

[Kenichi Handa]

Shuhei KOBAYASHI <shuhei ＠ aqua.ocn.ne.jp> writes:
> Elisp Manual の Tips for Documentation Strings より:
> ==============================

>    * An internal variable or subroutine of a Lisp program might as well
>      have a documentation string.  In earlier Emacs versions, you could
>      save space by using a comment instead of a documentation string,
>      but that is no longer the case--documentation strings now take up
>      very little space in a running Emacs.

> この変更(dynamic-docstrings)が入ったのは Emacs 19.29 からです.

> というわけで, internal な関数の docstring をわざわざ comment にすること
> はないというのに 1 票.

うーむ、こんなパラグラフがあったのには気が付きませんでした。^.^;;;

確かに product.el 自体を debug している時には doc-string が
あった方が便利ですしね。でも、現在のところ doc-string で
internal なものと API となるものの区別を付けるコンベンション
はないので、我々で決めてしまっても良いかと思います。internal
なものは全部
  "For internal use only.
...."
という形にするのも良いかもしれません。
	M-x apropos RET ^product- RET
で何が internal で何が API かすぐに分かるので。

−−　けんちゃん＠ＥＴＬ
      handa ＠ etl.go.jp