[PD] documenting messages to/from Pd and dynamic patching

[Alexandre Torres Porres]

> In particular, please don't include any GUI dialog messages

which are they all?

anyway, I felt I was crossing a line, hence I'm waving here to the judges
:)

For instance, [namecanvas] did include a 'msg' message to canvas. I count
that as a modest dynamic patch documentation.

Also, many of us use and abuse these for ages now... what if the
documentation also gives us a "heads up", some "warning" that this is
unstable and should be used assuming risks? This would be better than just
having people check for this kind of documentation in Pd-extended or
something and worse stuff.

But I see this might needs lots of debates, and as soon as I have more
input I can revise and move this to a github discussion and a parallel PR.

thanks

Em sex., 26 de nov. de 2021 às 17:18, Christof Ressi <info at christofressi.com>
escreveu:

> I think there are definitely many "official" messages (e.g. "dsp",
> "fast-forward", "quit", etc.) that need to be documented properly, so in
> principle I very much welcome this effort.
>
> However, I'm rather sceptical about including any "dynamic patching"
> messages in the official documentation as they are not officially
> supported. I think it would be better to exclude this from the main PR (
> https://github.com/pure-data/pure-data/pull/1455) and only offer this as
> a secondary PR (that you can rebase regularly on top of the other one).
>
> In particular, please don't include any GUI dialog messages. Those are
> really internal. Also, don't advertize "coords" (at least you didn't
> mention "donecanvasdialog") because that one should really be replaced by
> https://github.com/pure-data/pure-data/pull/627 (hopefully in the next Pd
> release :-)
>
> I think including dynamic patching would "taint" your otherwise great
> documentation updates.
>
> Christof
> On 26.11.2021 21:05, Alexandre Torres Porres wrote:
>
> the reason I ask for revisions here is that I'm not an expert on this dark
> magic, so I'm not 100% sure about things. I can revert the commit in the PR
> and keep it on the fridge for the next release update if the real wizards
> see problems on it.
>
> Em sex., 26 de nov. de 2021 às 16:59, Alexandre Torres Porres <
> porres at gmail.com> escreveu:
>
>> I could just send the main Patch, but it just works best if you have all
>> of the current state of the reference folder and also check other changes
>> I'm proposing in this PR, so see attachment of the whole thing.
>>
>> I got a rather broken keyboard, so I must be generating more typos than
>> usual. Will need to revise it!
>>
>> note that [Pd-messages] gets called in the help files of [send-receive],
>> 'message boxes' and [namecanvas], all of them have been rewritten as well.
>>
>> cheers
>>
>>
>>
>> Em sex., 26 de nov. de 2021 às 16:55, Alexandre Torres Porres <
>> porres at gmail.com> escreveu:
>>
>>> People, I'm on a roll here, updating much of the help files and
>>> documentation.
>>>
>>> I just hit an important new addition, documenting "Messages to/from Pd"
>>> and "Dynamic Patching"
>>>
>>> I'd like you people to revise it.
>>>
>>> Here's the commit =>
>>> https://github.com/pure-data/pure-data/pull/1455/commits/0ec5429629eb1045c901ab9c74befd124ccb6e69
>>>
>>> already in an open PR
>>>
>>> Cheers
>>>
>>
> _______________________________________________Pd-list at lists.iem.at mailing list
> UNSUBSCRIBE and account-management -> https://lists.puredata.info/listinfo/pd-list
>
> _______________________________________________
> Pd-list at lists.iem.at mailing list
> UNSUBSCRIBE and account-management ->
> https://lists.puredata.info/listinfo/pd-list
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.puredata.info/pipermail/pd-list/attachments/20211126/39f9fd46/attachment-0001.htm>