From 053a6c726f8bd871724bcf45978b63926bd5f769 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Fabi=C3=A1n=20Ezequiel=20Gallina?= Date: Thu, 17 May 2012 00:03:13 -0300 Subject: [PATCH] Docstrings enhancements --- lisp/progmodes/python.el | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index b11741d4a68..0b9d99cbbee 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -875,7 +875,7 @@ With numeric ARG, just insert that many colons. With "Regular expresion matching beginning of innermost class or function.") (defun python-nav-beginning-of-defun (&optional nodecorators) - "Move point to beginning-of-defun. + "Move point to `beginning-of-defun'. When NODECORATORS is non-nil decorators are not included. This is the main part of`python-beginning-of-defun-function' implementation." @@ -1566,11 +1566,13 @@ Optional argument JUSTIFY defines if the paragraph should be justified." (t t)))) (defun python-fill-comment (&optional justify) - "Comment fill function for `python-fill-paragraph-function'." + "Comment fill function for `python-fill-paragraph-function'. +JUSTIFY should be used (if applicable) as in `fill-paragraph'." (fill-comment-paragraph justify)) (defun python-fill-string (&optional justify) - "String fill function for `python-fill-paragraph-function'." + "String fill function for `python-fill-paragraph-function'. +JUSTIFY should be used (if applicable) as in `fill-paragraph'." (let ((marker (point-marker)) (string-start-marker (progn @@ -1610,11 +1612,13 @@ Optional argument JUSTIFY defines if the paragraph should be justified." (fill-paragraph justify)))) t) (defun python-fill-decorator (&optional justify) - "Decorator fill function for `python-fill-paragraph-function'." + "Decorator fill function for `python-fill-paragraph-function'. +JUSTIFY should be used (if applicable) as in `fill-paragraph'." t) (defun python-fill-paren (&optional justify) - "Paren fill function for `python-fill-paragraph-function'." + "Paren fill function for `python-fill-paragraph-function'. +JUSTIFY should be used (if applicable) as in `fill-paragraph'." (save-restriction (narrow-to-region (progn (while (python-info-ppss-context 'paren) -- 2.39.5