bug#39912: [PATCH] Open describe-function links in view-mode (Bug#39912)

["Nicholas Savage" <nick@nicksavage.ca>]

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

Thanks for the comments. I've attached an updated patch, and have responded to your points below.

On Tue, Sep 8, 2020, at 17:01, Stefan Kangas wrote:
> "Nicholas Savage" <nick@nicksavage.ca> writes:
> 
> > I've written a patch for Bug #39912, as discussed in debbugs. I think I
> > have formatted this correctly and have followed CONTRIBUTE as best as I
> > could.
> 
> Thanks!  I have some comments.
> 
> (Someone else will have to help you with getting the assignment process
> started.)

This is now underway!

> 
> > I've also changed it so the actual source code link opens in view-mode
> > as well. I don't know if there are ramifications of that, so I'm happy
> > to change it if necessary. My thought process was that
> > describe-function is used as a reference to the code, not as a point
> > of entry for editing functions, so changing that is consistent with
> > changing the NEWS links, but I don't know what I don't know.
> 
> Actually, I use it to edit the source code all the time.  That's what
> that button is mostly used for, in my use.  :-)
> 
> So I think we'd better leave that part out.
> 

Yeah, that makes sense now that I'm thinking about it. I thought it may be beyond the pale, which is why I wanted to highlight it. I've removed it now in the new attached patch. 

> > * Open describe-function links in view-mode (Bug#39912) to make
> > behavior consistent depending on whether or not user has permission
> > to edit the files.
> 
> The description is okay, but could be shorter (and should mention the
> link to NEWS button as discussed above).  I'm also not sure if its
> necessary to discuss file permissions here, since those details will be
> in the bug report.  Mentioning view-mode should be enough.
> 
> Also, this doesn't seem to follow the ChangeLog format.  If you use VC
> (or Magit) to edit the files, you can simply put point on the newly
> added line and type `C-x 4 a' to get it automatically generated.  You
> could even do it directly in the ELisp file, if point is in the changed
> function.  (Read CONTRIBUTE for more details.)

I didn't know about `C-x 4 a'. Is that better now? I have reworded the description as well.

I appreciate all of your advice and help! This has been my first real attempt at working in a development environment, as my day job is in a different industry, so there's a bit of a learning curve but I'm eager to catch up and contribute as I can.

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Open-describe-function-NEWS-links-in-view-mode-Bug-3.patch --]
[-- Type: text/x-patch; name="0001-Open-describe-function-NEWS-links-in-view-mode-Bug-3.patch", Size: 866 bytes --]

From 2e98047137e6f56494f8c41fdbf1d9d1275d0840 Mon Sep 17 00:00:00 2001
From: Nick Savage <nick@nicksavage.ca>
Date: Tue, 8 Sep 2020 16:08:30 -0400
Subject: [PATCH] Open describe-function NEWS links in view-mode (Bug#39912)

* lisp/help-mode.el (help-news): Open describe-function NEWS links in
view-mode (Bug#39912)

Copyright-paperwork-exempt: yes
---
 lisp/help-mode.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/help-mode.el b/lisp/help-mode.el
index 9c2d1d7227..7a5d405c01 100644
--- a/lisp/help-mode.el
+++ b/lisp/help-mode.el
@@ -308,7 +308,7 @@ 'help-news
   :supertype 'help-xref
   'help-function
   (lambda (file pos)
-    (pop-to-buffer (find-file-noselect file))
+    (view-buffer (find-file-noselect file))
     (goto-char pos))
   'help-echo (purecopy "mouse-2, RET: show corresponding NEWS announcement"))
 \f
-- 
2.20.1