Psionikus · 2022-11-06 05:33
I noticed that only the Tutorial seems to exist in a translated form. Not even the glossary of the Elisp manual or docstrings seems to have translations readily available.
I've started investigating in a second language to understand just what the experience is like for at least one other language.
**Are there any good tools or built-in support to offer replacement text for any of the most frequently needed documentation such as variable & function docstrings?**
arthurno1 · 2022-11-06 08:16
> Are there any good tools or built-in support to offer replacement text for any of the most frequently needed documentation such as variable & function docstrings?
Yes:
(put symbol 'variable-documentation "your translated variable doc string")
(put symbol 'function-documentation "your translated function doc string")
You can play with it in the scratch buffer:
(defvar test nil
"My test var.")
(get 'test 'variable-documentation)
(put 'test 'variable-documentation "New test docs")
(get 'test 'variable-documentation)
(defun test ()
"Do nothing function")
(documentation 'test)
There is a minor twist for function docs; you have first to put it to 'nil, then you can set your own docs, as explained nicely by [Chris W. in his blog](https://nullprogram.com/blog/2012/08/02/):
(put 'test 'function-documentation nil)
(put 'test 'function-documentation "Test function.")
(documentation 'test)
or use 'get' as well:
(get 'test 'function-documentation)
[Read the manual too!](https://emacsdocs.org/docs/elisp/Documentation-Basics)