search

tobyink / p5-zydeco

Perl 5 distribution Zydeco; see homepage for downloads and documentation.
https://zydeco.toby.ink/
14 stars 3 forks source link

Zydeco's documentation progress #10

Open smonff opened 3 years ago

smonff commented 3 years ago

Hi Toby,

Just a quick question about Zydeco's documentation.

Since some of the last sections of Zydeco's manual are in a work in progress state, I would like to ask if any help would be needed on this side: like if you would already have some quick notes, but it would require expansion or proofreading or whatever? I would be glad to help if possible.

tobyink commented 3 years ago

I don't have anything written for them yet, no.

Which parts do you think should be highest priority?

smonff commented 3 years ago

I guess Privacy, maybe because the method $name convention (with a $ prefixing private methods names) is not so intuitive. This is the one I first used without full documentation by reading the homepage examples (that are already quite understandable and well written). I wasn't very sure in the first time the $ sigil was the way to do it. The fact Zydeco brings "true privacy" and not only a "conventional privacy" (through sub _method_name { ... }) seems also interesting.

Then I would say the Parameterizable classes and roles part maybe, assuming I understand correctly what they are: classes and roles that have typed parameters (making a heavy use of Type::Tiny I guess) and enforce this strong typing during objects instantiations.

I am mostly curious about reading more of the TODO documentation. Maybe you first created the missing sections and then decided to not write them, dunno. On my side I sometimes tried to read the source code to know more about Zydeco, but, this is a bit way beyond my understanding. In this sense, I am also interested in the Beyond Zydeco section.