GNU bug report logs -
#60703
Patches to xwidget code
Previous Next
Full log
Message #53 received at 60703 <at> debbugs.gnu.org (full text, mbox):
[Message part 1 (text/plain, inline)]
Let me know if this ChangeLog is fine or you'd like me to make any changes.
The first line of a doc string should be a single complete sentence.
>
I'm not sure I follow: in this case, isn't this the first line: "Get the
estimated load progress of XWIDGET, a WebKit widget."? It renders fine when
I run `M-x apropos xwidget-webkit-estimated-load-progress`. But happy to
make any additional changes if needed.
On Wed, Feb 22, 2023 at 8:26 AM Eli Zaretskii <eliz <at> gnu.org> wrote:
> > From: Andrew De Angelis <bobodeangelis <at> gmail.com>
> > Date: Tue, 21 Feb 2023 00:24:06 -0500
> > Cc: luangruo <at> yahoo.com, 60703 <at> debbugs.gnu.org
> >
> > Done. (git diff forked/emacs-29 > emacs-29-xwidget-patches.patch)
> >
> > Let me know if there's anything I should do. Thanks!
>
> Thanks, what is missing now is the commit log message. Please see
> CONTRIBUTE and the examples in the Git repository, for how we format
> the log messages.
>
> One minor comment to the code:
>
> > +DEFUN ("xwidget-webkit-estimated-load-progress",
> > + Fxwidget_webkit_estimated_load_progress,
> Sxwidget_webkit_estimated_load_progress,
> > + 1, 1, 0, doc: /* Get the estimated load progress of XWIDGET, a
> WebKit widget.
> > +Return a value ranging from 0.0 to 1.0, based on how close XWIDGET
> > +is to completely loading its page. */)
>
> The first line of a doc string should be a single complete sentence.
> This is because commands like "M-x apropos" show only the first line.
>
> (Yes, I'm aware that you just moved existing code, but still: let's
> fix this while we are at that.)
>
[Message part 2 (text/html, inline)]
[ChangeLog.andrewda (application/octet-stream, attachment)]
This bug report was last modified 2 years and 79 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.