* (elisp) Generic Functions cl-defmethod documentation bug?
@ 2018-01-01 13:37 Stephen Leake
2018-01-02 5:09 ` Stefan Monnier
0 siblings, 1 reply; 6+ messages in thread
From: Stephen Leake @ 2018-01-01 13:37 UTC (permalink / raw)
To: emacs-devel
In the elisp manual node Generic Functions, the documentation for
'cl-defmethod' includes:
‘STRUCT-TAG’
The argument must be an instance of a class named STRUCT-TAG
defined with ‘cl-defstruct’ (*note (cl)Structures::), or of
one of its parent classes.
Shouldn't 'parent classes' be 'child classes'?
The method requires an object that has all the fields defined in the given
struct; that is true of child classes, not parents.
Unless I'm missing something.
--
-- Stephe
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: (elisp) Generic Functions cl-defmethod documentation bug?
2018-01-01 13:37 (elisp) Generic Functions cl-defmethod documentation bug? Stephen Leake
@ 2018-01-02 5:09 ` Stefan Monnier
2018-01-02 13:41 ` Stephen Leake
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Monnier @ 2018-01-02 5:09 UTC (permalink / raw)
To: emacs-devel
> ‘STRUCT-TAG’
> The argument must be an instance of a class named STRUCT-TAG
> defined with ‘cl-defstruct’ (*note (cl)Structures::), or of
> one of its parent classes.
>
> Shouldn't 'parent classes' be 'child classes'?
That sounds right, indeed. And instead of "tag" it should say "type"
since this is a type and not a tag.
Stefan
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: (elisp) Generic Functions cl-defmethod documentation bug?
2018-01-02 5:09 ` Stefan Monnier
@ 2018-01-02 13:41 ` Stephen Leake
2018-01-02 15:45 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Stephen Leake @ 2018-01-02 13:41 UTC (permalink / raw)
To: emacs-devel
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> ‘STRUCT-TAG’
>> The argument must be an instance of a class named STRUCT-TAG
>> defined with ‘cl-defstruct’ (*note (cl)Structures::), or of
>> one of its parent classes.
>>
>> Shouldn't 'parent classes' be 'child classes'?
>
> That sounds right, indeed. And instead of "tag" it should say "type"
> since this is a type and not a tag.
Ok, committed in b6add8c7
--
-- Stephe
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: (elisp) Generic Functions cl-defmethod documentation bug?
2018-01-02 13:41 ` Stephen Leake
@ 2018-01-02 15:45 ` Eli Zaretskii
2018-01-03 22:57 ` Stephen Leake
0 siblings, 1 reply; 6+ messages in thread
From: Eli Zaretskii @ 2018-01-02 15:45 UTC (permalink / raw)
To: Stephen Leake; +Cc: emacs-devel
> From: Stephen Leake <stephen_leake@stephe-leake.org>
> Date: Tue, 02 Jan 2018 07:41:19 -0600
>
> Stefan Monnier <monnier@iro.umontreal.ca> writes:
>
> >> ‘STRUCT-TAG’
> >> The argument must be an instance of a class named STRUCT-TAG
> >> defined with ‘cl-defstruct’ (*note (cl)Structures::), or of
> >> one of its parent classes.
> >>
> >> Shouldn't 'parent classes' be 'child classes'?
> >
> > That sounds right, indeed. And instead of "tag" it should say "type"
> > since this is a type and not a tag.
>
> Ok, committed in b6add8c7
Thanks, but why to master? Documentation patches should be pushed to
the release branch.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: (elisp) Generic Functions cl-defmethod documentation bug?
2018-01-02 15:45 ` Eli Zaretskii
@ 2018-01-03 22:57 ` Stephen Leake
2018-01-04 3:36 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Stephen Leake @ 2018-01-03 22:57 UTC (permalink / raw)
To: emacs-devel
Eli Zaretskii <eliz@gnu.org> writes:
>> From: Stephen Leake <stephen_leake@stephe-leake.org>
>> Date: Tue, 02 Jan 2018 07:41:19 -0600
>>
>> Stefan Monnier <monnier@iro.umontreal.ca> writes:
>>
>> >> ‘STRUCT-TAG’
>> >> The argument must be an instance of a class named STRUCT-TAG
>> >> defined with ‘cl-defstruct’ (*note (cl)Structures::), or of
>> >> one of its parent classes.
>> >>
>> >> Shouldn't 'parent classes' be 'child classes'?
>> >
>> > That sounds right, indeed. And instead of "tag" it should say "type"
>> > since this is a type and not a tag.
>>
>> Ok, committed in b6add8c7
>
> Thanks, but why to master? Documentation patches should be pushed to
> the release branch.
Sorry, I realized that after I committed.
I found instructions for backporting a commit in
admin/notes/git-workflow:
-------------
cd ~/emacs/emacs-26
git cherry-pick -xe b6add8c7...
and add "Backport:" to the commit string.
git push
-------------
is that the correct process?
--
-- Stephe
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: (elisp) Generic Functions cl-defmethod documentation bug?
2018-01-03 22:57 ` Stephen Leake
@ 2018-01-04 3:36 ` Eli Zaretskii
0 siblings, 0 replies; 6+ messages in thread
From: Eli Zaretskii @ 2018-01-04 3:36 UTC (permalink / raw)
To: Stephen Leake; +Cc: emacs-devel
> From: Stephen Leake <stephen_leake@stephe-leake.org>
> Date: Wed, 03 Jan 2018 16:57:29 -0600
>
> I found instructions for backporting a commit in
> admin/notes/git-workflow:
>
> -------------
> cd ~/emacs/emacs-26
> git cherry-pick -xe b6add8c7...
>
> and add "Backport:" to the commit string.
>
> git push
> -------------
>
> is that the correct process?
Yes, thanks.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2018-01-04 3:36 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-01-01 13:37 (elisp) Generic Functions cl-defmethod documentation bug? Stephen Leake
2018-01-02 5:09 ` Stefan Monnier
2018-01-02 13:41 ` Stephen Leake
2018-01-02 15:45 ` Eli Zaretskii
2018-01-03 22:57 ` Stephen Leake
2018-01-04 3:36 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).