Est-il possible de formater plus facilement l'aide pour une fonction?

Question

Lorsque j'utilise describe-function, le texte de la documentation s'affiche dans un tampon d'aide.

Si le document est assez long, il s'enroulera dans le tampon, mais il ne s'enroulera pas bien. comme ceci:

je peux rendre l'utilisation de lignes docstring 72 caractères, mais cela suppose que la fenêtre sera de 80 caractères, ce qui est pas toujours le cas.

Est-il possible d'obtenir describe-function pour émettre de la documentation d'une manière plus joliment formatée?

Answer 1

Essayez d'activer global-visual-line-mode pour obtenir un habillage de texte agréable dans tous vos tampons. Cela fonctionne dans les tampons de code et d'aide, mais ne gâche pas votre numérotation de ligne! De tous les modes de retour à la ligne pour emacs, je trouve que c'est le meilleur. Si vous ne voulez pas l'utiliser globalement, essayez simplement M-x visual-line-mode.

Answer 2

Non, veuillez faire et non "essayez d'activer le mode global-visual-line" comme solution pour cela. Essayez simplement d'adopter les conventions Emacs pour les chaînes de documentation.

Voir le manuel Elisp, noeud Documentation Tips (alias "Tips for Documentation Strings").

En général, les chaînes de document ne doivent pas avoir des lignes plus larges que 60 caractères. N'oubliez pas qu'il existe plusieurs endroits où Emacs utilise des chaînes de doc, y compris pour apropos. Emacs s'attend à ce que les chaînes de documentation suivent les conventions documentées, pour de meilleurs résultats.