GNU bug report logs - #33516
Should the docstring for flymake-diag-region mention behavior with narrowing?

Previous Next

Package: emacs;

Reported by: Matthew Bregg <bregg <at> google.com>

Date: Mon, 26 Nov 2018 18:36:01 UTC

Severity: minor

Tags: wontfix

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 33516 in the body.
You can then email your comments to 33516 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#33516; Package emacs. (Mon, 26 Nov 2018 18:36:01 GMT) Full text and rfc822 format available.
Acknowledgement sent to Matthew Bregg <bregg <at> google.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Mon, 26 Nov 2018 18:36:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Matthew Bregg <bregg <at> google.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Should the docstring for flymake-diag-region mention behavior with
 narrowing?
Date: Mon, 26 Nov 2018 11:46:18 -0600

[Message part 1 (text/plain, inline)]
Currently it can be confusing when developing a flymake checker that
flymake-diag-region does not handle narrowing.

Updating the comment to mention this seems useful to me.

Thanks!

[Message part 2 (text/html, inline)]
[0001-Update-documentation-for-flymake.patch (text/x-patch, attachment)]
Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#33516; Package emacs. (Tue, 09 Jul 2019 23:49:01 GMT) Full text and rfc822 format available.

Message #8 received at 33516 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Matthew Bregg <bregg <at> google.com>
Cc: 33516 <at> debbugs.gnu.org
Subject: Re: bug#33516: Should the docstring for flymake-diag-region mention
 behavior with narrowing?
Date: Wed, 10 Jul 2019 01:48:45 +0200

Matthew Bregg <bregg <at> google.com> writes:

> Currently it can be confusing when developing a flymake checker that
> flymake-diag-region does not handle narrowing.
>
> Updating the comment to mention this seems useful to me.

[...]

> -region is invalid."
> +region is invalid.
> +If the BUFFER has been narrowed,
> +the region returned will correspond to the BUFFER's narrowed state."

Hm...  I think we generally assume that all functions (except explicitly
documented not to) work on the narrowed section of a buffer?  So
documenting this in this specific function doesn't seem natural do me,
and I'm closing this bug report.  If somebody disagrees, please reopen.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no
Added tag(s) wontfix. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Tue, 09 Jul 2019 23:49:02 GMT) Full text and rfc822 format available.
bug closed, send any further explanations to 33516 <at> debbugs.gnu.org and Matthew Bregg <bregg <at> google.com> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Tue, 09 Jul 2019 23:49:02 GMT) Full text and rfc822 format available.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Wed, 07 Aug 2019 11:24:05 GMT) Full text and rfc822 format available.
This bug report was last modified 4 years and 253 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.