Re: [AUCTeX-devel] pretty patch

[Tassilo Horn]

Uwe Brauer <address@hidden> writes:

Hi Uwe,

> This patch is correct, I applied it and checked the resulting
> auctex.texi which compiles and double space at sentence-end. The only
> thing is the ChangeLog message, that seems bizzare is not the message
> from my last commit.

What you submitted is a patch for two mercurial changesets.  I.e., the
first one is the one that didn't compile (because there's the
@font-latex-fontify-script{} and «...»), and the second one is your
final result.

I'm not interested in the history of how you came to the final result
and don't want to have a non-compilable revision for no reason, so could
you please create a patch that just presents your final result.  (So
basically, what I request is that you squash your two commits into one.
You'd do that with git rebase --interactive.  There's also a rebase
extension for mercurial though I can't tell you how to operate it
exactly.)

Anyway, some comments towards the final patch below:

> # HG changeset patch
> # User Uwe Brauer <address@hidden>
> # Date 1474105692 0
> #      Sat Sep 17 09:48:12 2016 +0000
> # Node ID 076c97473ae4ed447c4805a5d1067547da3d9a60
> # Parent  b60638f575a06f0ca4c57cfd80d7f9fd72864e5f
> Correct incorrect filling caused by sentence-end-double-space
>
> to nil. Change «_» and «^» to  @code{^} and @code{_}, Change
> @font-latex-fontify-script{} -->  @code{font-latex-fontify-script}.

Please use this commit message format:

--8<---------------cut here---------------start------------->8---
<one very brief summary line>

<Changes and additions using ChangeLog format>
--8<---------------cut here---------------end--------------->8---

To generate valid ChangeLog style messages, simply place point on the
text you changed or edited (or on the hunk in a diff buffer) and do `C-x
4 a'.  That will query for a ChangeLog file.  We don't have them
anymore, so just create a new one.  Take your notes, and then kill and
yank it into your commit message.

> diff --git a/doc/auctex.texi b/doc/auctex.texi
> --- a/doc/auctex.texi
> +++ b/doc/auctex.texi
> @@ -1812,19 +1812,18 @@
>  narrow the buffer to the current group and to @LaTeX{} environments.
>  
>  Another tool to obtain more WYSIWYG feeling is to set
> address@hidden to ‘invisible’ so that the «^» and «_» in
> -sub and superscripts are not displayed.
> address@hidden to ‘invisible’ so that the @code{^} and
> address@hidden in sub and superscripts are not displayed.

Please use @code{} also for "invisible".  That will add the quotes
automatically.

>  Lastly, @AUCTeX{} with GNU Emacs 25 or later can display certain math
> -macros using Unicode characters. That's called prettification. XEmacs
> -user should either switch to GNU Emacs 25 or use the x-symbol package
> -which provides a similar feature. Prettification is pretty lightweight
> -and reasonable robust, however it only provides a limited WYSIWYG feature,
> -compared to @previewlatex{} a subsystem of @AUCTeX{}, see
> address@hidden,,Introduction,preview-latex,The @previewlatex{} Manual}, which
> -let LaTeX generate images that are displayed in your buffer. It is
> -extremely accurate but sometimes fragile with some packages. Note please
> -that you can use prettification and preview-latex together. 
> +macros using Unicode characters.  That's called prettification.
> +Prettification is pretty lightweight and reasonable robust, however
> it

I think you can remove that pretty, the text is very prettified
anyhow. ;-)

> +only provides a limited WYSIWYG feature, compared to @previewlatex{}
> a

Remove the comma after feature.

> +subsystem of @AUCTeX{}, see @ref{Top,,Introduction,preview-latex,The

Use @xref here which will generate the "see ..." automatically.

> address@hidden Manual}, which let LaTeX generate images that are

Remove the comma before which.

> +displayed in your buffer.  It is extremely accurate but sometimes fragile
> +with some packages.  Note please that you can use prettification and
> +preview-latex together.

Please note instead of Note please.

>  @menu
>  * Font Locking::                Font Locking
> @@ -2186,9 +2185,9 @@
>  @defopt font-latex-fontify-script
>  If non-nil, fontify subscript and superscript strings.
>  
> -In addition you can configure Emacs so that the «^» and «_» in sub and
> -superscripts are not displayed. To enable that feature you have to set
> -the variable @font-latex-fontify-script{} to ‘invisible’.
> +In addition you can configure Emacs so that the @code{^} and @code{_} in
> +sub and superscripts are not displayed.  To enable that feature you have
> +to set the variable @code{font-latex-fontify-script} to ‘invisible’.

As mentioned above: @code{invisible}.

>  Note that this feature is not available on XEmacs, for which it is
>  disabled per default.  In GNU Emacs raising and lowering is not enabled
> @@ -2608,13 +2607,13 @@
>  Lisp buffers.
>  
>  @AUCTeX{} can use this feature in order to display certain math macros
> -and greek letters using their Unicode representation, too. For example,
> +and greek letters using their Unicode representation, too.  For example,
>  the @TeX{} code @code{\alpha \times \beta} will be displayed as @code{α
> -× β}. When point is on one of the characters, it'll be unprettified
> -automatically, meaning you see the verbatim text again. Note that when
> +× β}.  When point is on one of the characters, it'll be unprettified
> +automatically, meaning you see the verbatim text again.  Note that when
>  you inserted \alpha which gets displayed as α, hitting delete after it
>  will result in \alph, i.e., just one character is deleted, not the
> -complete macro which just gets displayed as α. To delete the whole
> +complete macro which just gets displayed as α.  To delete the whole
>  macro, use @code{kill-word} or @code{backward-kill-word}.

Now I know why you think this delete thingy needs a remark while I
didn't think so.  I've set `prettify-symbols-unprettify-at-point' to
`right-edge' since it existed (and to t before that).  So when point is
immediately at the right edge of a prettified symbol here, it is
unprettified.  That makes it extremely obvious that <backspace> will
only delete one char and not the complete symbol.

Bye,
Tassilo