pure-data / pddp

Pure Data Documentation Project
9 stars 2 forks source link

How can we clarify confusion in G05 example patch? #196

Closed maftkd closed 5 months ago

maftkd commented 5 months ago

This is a very minor issue, but the comment in G05 did confuse me, so maybe it will help others if we clarify it.

The patch is designed to teach how the sort order of [delwrite~] and [delread4~] matter when it comes to really small delays (smaller than 1 block). The patch uses a "correct" branch outlined in red that uses subpatches to guarantee sort order, and then an "incorrect" branch outlined in green where sort order is not correct.

image

The comment kind of throws me off: "off to hear left-hand side; on to hear right hand side."

It's a bit confusing because the left and right sides sort of criss-cross towards the bottom of the patch.

When the toggle is off, what you actually hear is the [delread4~] outlined in green, and when it is on you hear the subpatches outlined in red, which is sort of the reverse of what I would expect given the comment.

Further adding to the confusion, when the toggle is on, the "wrong" version outlined in green appears to always be included in the output regardless of the toggle due to the way the [+~] blocks are laid out.

So what do you all think? Is this worth clarifying, or am I just missing something? If worth clarifying, should we change the comment, or even change the layout of the patch to more clearly separate the "correct" and "incorrect" branches. I'm happy to make a proposed change, but wanted to verify that this makes sense to others first as I am still relatively new to PD (hence working through the example patches in painstaking detail)

CC @ben-wes - thank you for directing this issue to the appropriate location CC @porres - as the maintainer of the documentation PRs

maftkd commented 5 months ago

Note: this issue was mistakenly posted in the wrong project previously: https://github.com/pure-data/pure-data/issues/2263

But I did want to highlight @ben-wes's proposed solution here so we could discuss it further:

image

ben-wes commented 5 months ago

this is a bit nitpicky now - but to make the left/right switch more transparent, we could even have sth like this:

image

porres commented 5 months ago

I guess a clearer switch makes better sense, will do

porres commented 5 months ago

just did this Screen Shot 2024-04-17 at 23 37 33

maftkd commented 5 months ago

So much cleaner! Thanks @porres!