GNU bug report logs - #67621
[PATCH] documentation for ert-font-lock

Previous Next

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

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

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

From: Vladimir Kazanov <vekazanov <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] documentation for ert-font-lock
Date: Mon, 4 Dec 2023 12:19:55 +0000

[Message part 1 (text/plain, inline)]

Hi team,

As (reasonably) requested in emacs-devel@ [1], sending a patch that
adds ert-font-lock to NEWS and expands the ERT manual.

[1] https://lists.gnu.org/archive/html/emacs-devel/2023-12/msg00082.html

-- 
Regards,

Vladimir Kazanov

[0001-add-ert-font-lock-docs.patch (text/x-patch, attachment)]

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

From: Michael Albinus <michael.albinus <at> gmx.de>
To: Vladimir Kazanov <vekazanov <at> gmail.com>
Cc: 67621 <at> debbugs.gnu.org
Subject: Re: bug#67621: [PATCH] documentation for ert-font-lock
Date: Mon, 04 Dec 2023 14:01:40 +0100

Vladimir Kazanov <vekazanov <at> gmail.com> writes:

> Hi team,

Hi Vladimir,

> As (reasonably) requested in emacs-devel@ [1], sending a patch that
> adds ert-font-lock to NEWS and expands the ERT manual.

Thanks. Just some few comments.

> --- a/doc/misc/ert.texi
> +++ b/doc/misc/ert.texi
> @@ -526,6 +526,7 @@ How to Write Tests
>  * Tests and Their Environment:: Don't depend on customizations; no side effects.
>  * Useful Techniques::           Some examples.
>  * erts files::                  Files containing many buffer tests.
> +* Syntax Highlighting Tests:: Tests for face assignment.
>  @end menu

Align the entries. "Tests" must be at the same position as "Files".

> +Syntax highlighting is normally provided by the Font Lock minor mode
> +that assigns face properties to parts of the buffer. The

Use two spaces at sentence end. This is for everything in ert.texi and
NEWS.

> +Test assertion parser extracts tests from comment-only lines. Every
> +comment assertion line starts either with a caret ('^') or an arrow
> +('<-'). A caret/arrow should be followed immedately by the name of a
> +face to be checked.

Use @samp here, like (@samp{^}) and (@samp{<-}) .

> +i.e. @code{:tag} and @code{:expected-result}.

Please write i.e.,

> --- a/etc/NEWS
> +++ b/etc/NEWS
> +** ERT
> +
> ++++
> +*** Syntax highlighting unit testing support

This needs a trailing period.

> +An ERT extension ('ert-font-lock') now provides support for face
> +assignment unit testing.

Since it doesn't tell details, you might refer to the manual. like

--8<---------------cut here---------------start------------->8---
An ERT extension ('ert-font-lock') now provides support for face
assignment unit testing.  For more information, see the "(ert) Syntax
Highlighting Tests" node in the ERT manual.
--8<---------------cut here---------------end--------------->8---

> Regards,
>
> Vladimir Kazanov

Best regards, Michael.

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

From: Vladimir Kazanov <vekazanov <at> gmail.com>
To: Michael Albinus <michael.albinus <at> gmx.de>
Cc: 67621 <at> debbugs.gnu.org
Subject: Re: bug#67621: [PATCH] documentation for ert-font-lock
Date: Mon, 4 Dec 2023 13:29:36 +0000

[Message part 1 (text/plain, inline)]

Michael,

Thank you for reviewing the patch!

Attached is an updated patch.

Thanks,
Vlad

On Mon, 4 Dec 2023 at 13:01, Michael Albinus <michael.albinus <at> gmx.de> wrote:
>
> Vladimir Kazanov <vekazanov <at> gmail.com> writes:
>
> > Hi team,
>
> Hi Vladimir,
>
> > As (reasonably) requested in emacs-devel@ [1], sending a patch that
> > adds ert-font-lock to NEWS and expands the ERT manual.
>
> Thanks. Just some few comments.
>
> > --- a/doc/misc/ert.texi
> > +++ b/doc/misc/ert.texi
> > @@ -526,6 +526,7 @@ How to Write Tests
> >  * Tests and Their Environment:: Don't depend on customizations; no side effects.
> >  * Useful Techniques::           Some examples.
> >  * erts files::                  Files containing many buffer tests.
> > +* Syntax Highlighting Tests:: Tests for face assignment.
> >  @end menu
>
> Align the entries. "Tests" must be at the same position as "Files".
>
> > +Syntax highlighting is normally provided by the Font Lock minor mode
> > +that assigns face properties to parts of the buffer. The
>
> Use two spaces at sentence end. This is for everything in ert.texi and
> NEWS.
>
> > +Test assertion parser extracts tests from comment-only lines. Every
> > +comment assertion line starts either with a caret ('^') or an arrow
> > +('<-'). A caret/arrow should be followed immedately by the name of a
> > +face to be checked.
>
> Use @samp here, like (@samp{^}) and (@samp{<-}) .
>
> > +i.e. @code{:tag} and @code{:expected-result}.
>
> Please write i.e.,
>
> > --- a/etc/NEWS
> > +++ b/etc/NEWS
> > +** ERT
> > +
> > ++++
> > +*** Syntax highlighting unit testing support
>
> This needs a trailing period.
>
> > +An ERT extension ('ert-font-lock') now provides support for face
> > +assignment unit testing.
>
> Since it doesn't tell details, you might refer to the manual. like
>
> --8<---------------cut here---------------start------------->8---
> An ERT extension ('ert-font-lock') now provides support for face
> assignment unit testing.  For more information, see the "(ert) Syntax
> Highlighting Tests" node in the ERT manual.
> --8<---------------cut here---------------end--------------->8---
>
> > Regards,
> >
> > Vladimir Kazanov
>
> Best regards, Michael.



-- 
Regards,

Vladimir Kazanov

[0001-add-ert-font-lock-docs.patch (text/x-patch, attachment)]

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

From: Michael Albinus <michael.albinus <at> gmx.de>
To: Vladimir Kazanov <vekazanov <at> gmail.com>
Cc: 67621 <at> debbugs.gnu.org
Subject: Re: bug#67621: [PATCH] documentation for ert-font-lock
Date: Mon, 04 Dec 2023 15:02:16 +0100

Vladimir Kazanov <vekazanov <at> gmail.com> writes:

> Michael,

Hi Vlad,

> Attached is an updated patch.

Almost fine. Except

>  @menu
> -* The @code{should} Macro::          A powerful way to express assertions.
> +* The @code{should} Macro::     A powerful way to express assertions.

Please don't change, it is intended. The @code{} clause isn't visible in
the resulting output. Best would be you check the result in info.

> +The @code{ert-font-lock-deftest} and @code{ert-font-lock-deftest-file}
> +macros accept the same keyword parameteres as @code{ert-deftest} i.e.,
                                  ^^ typo?

> Thanks,
> Vlad

Best regards, Michael.

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

From: Vladimir Kazanov <vekazanov <at> gmail.com>
To: Michael Albinus <michael.albinus <at> gmx.de>
Cc: 67621 <at> debbugs.gnu.org
Subject: Re: bug#67621: [PATCH] documentation for ert-font-lock
Date: Mon, 4 Dec 2023 14:42:11 +0000

[Message part 1 (text/plain, inline)]

Michael,

Thanks a lot! Here's the fixed patch.

Vlad

On Mon, 4 Dec 2023 at 14:02, Michael Albinus <michael.albinus <at> gmx.de> wrote:
>
> Vladimir Kazanov <vekazanov <at> gmail.com> writes:
>
> > Michael,
>
> Hi Vlad,
>
> > Attached is an updated patch.
>
> Almost fine. Except
>
> >  @menu
> > -* The @code{should} Macro::          A powerful way to express assertions.
> > +* The @code{should} Macro::     A powerful way to express assertions.
>
> Please don't change, it is intended. The @code{} clause isn't visible in
> the resulting output. Best would be you check the result in info.
>
> > +The @code{ert-font-lock-deftest} and @code{ert-font-lock-deftest-file}
> > +macros accept the same keyword parameteres as @code{ert-deftest} i.e.,
>                                   ^^ typo?
>
> > Thanks,
> > Vlad
>
> Best regards, Michael.



-- 
Regards,

Vladimir Kazanov

[0001-add-ert-font-lock-docs.patch (text/x-patch, attachment)]

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

From: Michael Albinus <michael.albinus <at> gmx.de>
To: Vladimir Kazanov <vekazanov <at> gmail.com>
Cc: 67621 <at> debbugs.gnu.org
Subject: Re: bug#67621: [PATCH] documentation for ert-font-lock
Date: Mon, 04 Dec 2023 16:15:59 +0100

Vladimir Kazanov <vekazanov <at> gmail.com> writes:

> Michael,

Hi Vlad,

> Thanks a lot! Here's the fixed patch.

Fine. Let's wait for a couple of days, and if nobody objects, I'll push
it for you.

> Vlad

Best regards, Michael.

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

From: Vladimir Kazanov <vekazanov <at> gmail.com>
To: Michael Albinus <michael.albinus <at> gmx.de>
Cc: 67621 <at> debbugs.gnu.org
Subject: Re: bug#67621: [PATCH] documentation for ert-font-lock
Date: Fri, 8 Dec 2023 13:47:59 +0000

Hi Michael,

It seems that there are no objections to the documentation update.
Should we add it, or do you have any other worthwhile additions in
mind?

Thank you,
Vlad

On Mon, 4 Dec 2023 at 15:16, Michael Albinus <michael.albinus <at> gmx.de> wrote:
>
> Vladimir Kazanov <vekazanov <at> gmail.com> writes:
>
> > Michael,
>
> Hi Vlad,
>
> > Thanks a lot! Here's the fixed patch.
>
> Fine. Let's wait for a couple of days, and if nobody objects, I'll push
> it for you.
>
> > Vlad
>
> Best regards, Michael.



-- 
Regards,

Vladimir Kazanov

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

From: Michael Albinus <michael.albinus <at> gmx.de>
To: Vladimir Kazanov <vekazanov <at> gmail.com>
Cc: 67621 <at> debbugs.gnu.org
Subject: Re: bug#67621: [PATCH] documentation for ert-font-lock
Date: Fri, 08 Dec 2023 14:56:20 +0100

Vladimir Kazanov <vekazanov <at> gmail.com> writes:

> Hi Michael,

Hi Vlad,

> It seems that there are no objections to the documentation update.
> Should we add it, or do you have any other worthwhile additions in
> mind?

Usually, we give people a week or so for comments. Some of them, like
the maintainers, are very busy.

However, I have already scheduled to push your patch later this weekend
(which is less than a week). I don't expect serious objections.

> Thank you,
> Vlad

Best regards, Michael.

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

From: Michael Albinus <michael.albinus <at> gmx.de>
To: Vladimir Kazanov <vekazanov <at> gmail.com>
Cc: 67621 <at> debbugs.gnu.org
Subject: Re: bug#67621: [PATCH] documentation for ert-font-lock
Date: Sat, 09 Dec 2023 10:29:03 +0100

Vladimir Kazanov <vekazanov <at> gmail.com> writes:

> Michael,

Hi Vlad,

> Thanks a lot! Here's the fixed patch.

Pushed to the master branch.

> Vlad

Best regards, Michael.

Previous Next

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