[nongnu] elpa/git-commit 8afc26f8ff 1/2: Improve docstring of magit alias

[ELPA Syncer]

branch: elpa/git-commit
commit 8afc26f8ff81e0e5a902633e7e22a4f3afcc71de
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>

    Improve docstring of magit alias
    
    The purpose of this alias is to make `magit-status' -- the main
    entry point -- discoverable for complete beginners who have read
    zero documentation.  See #3290.
    
    Optimize that line of the docstring for that purpose.  Depending
    on the used completion framework and customization, that might be
    shown in the minibuffer after, e.g., "M-x m a g TAB".
    
    I have also contemplated removing this alias because it gets in the
    way of having, e.g., "M-x m a g TAB" complete to "magit-" instead of
    merely "magit".  I might still do that, but for now I have decided
    that it is not enough of an issue when using a suitable completion
    framework and settings.
---
 lisp/magit-status.el | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lisp/magit-status.el b/lisp/magit-status.el
index 8b6a6bd837..2deecb490c 100644
--- a/lisp/magit-status.el
+++ b/lisp/magit-status.el
@@ -290,7 +290,9 @@ prefix arguments:
 
 ;;;###autoload
 (defalias 'magit #'magit-status
-  "An alias for `magit-status' for better discoverability.
+  "Begin using Magit.
+
+This alias for `magit-status' exists for better discoverability.
 
 Instead of invoking this alias for `magit-status' using
 \"M-x magit RET\", you should bind a key to `magit-status'