Re: master f9e354e: Spelling and wording fixes

Re: master f9e354e: Spelling and wording fixes

[Glenn Morris]

Paul Eggert wrote:

> -Doesn't let you edit the URL like `browse-url'.  Variable
> +Don't let you edit the URL like `browse-url'.  Variable
[...]
> -but point is not changed.  Doesn't let you edit the URL like
> +but point is not changed.  Don't let you edit the URL like

This change don't look right?

Re: master f9e354e: Spelling and wording fixes

[Paul Eggert]

On 03/17/2015 05:51 PM, Glenn Morris wrote:
> Paul Eggert wrote:
>
>> -Doesn't let you edit the URL like `browse-url'.  Variable
>> +Don't let you edit the URL like `browse-url'.  Variable
> [...]
>> -but point is not changed.  Doesn't let you edit the URL like
>> +but point is not changed.  Don't let you edit the URL like
> This change don't look right?

It uses active voice instead of third-person, which I thought was the 
preferred style.  I can change it back if you like, it's no big deal.

Re: master f9e354e: Spelling and wording fixes

[Stephen J. Turnbull]

Paul Eggert writes:

 > On 03/17/2015 05:51 PM, Glenn Morris wrote:
 > > Paul Eggert wrote:

 > >> -but point is not changed.  Doesn't let you edit the URL like
 > >> +but point is not changed.  Don't let you edit the URL like
 > > This change don't look right?
 > 
 > It uses active voice instead of third-person, which I thought was the 
 > preferred style.  I can change it back if you like, it's no big deal.

Active voice is preferred.  However, semantically your phrasing seems
quite awkward to me.  I would prefer "Inhibits editing of the URL ..."
which is also somewhat awkward, I don't say it's optimal.  Maybe
something like "makes URL read-only"?

Re: master f9e354e: Spelling and wording fixes

[Paul Eggert]

[-- Attachment #1: Type: text/plain, Size: 372 bytes --]

Stephen J. Turnbull wrote:
> semantically your phrasing seems quite awkward to me

True.  Let's omit that sentence.  First, the point doesn't appear to be that 
important.  Second, it's typically more confusing to document a procedure 
*doesn't* do than to document what the procedure *does* do.  So I installed the 
attached.  Undoubtedly this could be further improved.

[-- Attachment #2: 0001-lisp-net-browse-url.el-Omit-confusing-documentation.patch --]
[-- Type: text/x-patch, Size: 1445 bytes --]

From 94a90c867853f83d5f833dfd910919af9209c71b Mon Sep 17 00:00:00 2001
From: Paul Eggert <eggert@cs.ucla.edu>
Date: Tue, 17 Mar 2015 20:55:02 -0700
Subject: [PATCH] * lisp/net/browse-url.el: Omit confusing documentation.

---
 lisp/net/browse-url.el | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/lisp/net/browse-url.el b/lisp/net/browse-url.el
index dff587e..b44bb71 100644
--- a/lisp/net/browse-url.el
+++ b/lisp/net/browse-url.el
@@ -862,8 +862,7 @@ first, if that exists."
 ;;;###autoload
 (defun browse-url-at-point (&optional arg)
   "Ask a WWW browser to load the URL at or before point.
-Don't let you edit the URL like `browse-url'.  Variable
-`browse-url-browser-function' says which browser to use."
+Variable `browse-url-browser-function' says which browser to use."
   (interactive "P")
   (let ((url (browse-url-url-at-point)))
     (if url
@@ -876,9 +875,8 @@ Don't let you edit the URL like `browse-url'.  Variable
 (defun browse-url-at-mouse (event)
   "Ask a WWW browser to load a URL clicked with the mouse.
 The URL is the one around or before the position of the mouse click
-but point is not changed.  Don't let you edit the URL like
-`browse-url'.  Variable `browse-url-browser-function' says which browser
-to use."
+but point is not changed.  Variable `browse-url-browser-function'
+says which browser to use."
   (interactive "e")
   (save-excursion
     (mouse-set-point event)
-- 
2.1.0