Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zydeco's documentation progress #10

Open
smonff opened this issue Mar 10, 2021 · 2 comments
Open

Zydeco's documentation progress #10

smonff opened this issue Mar 10, 2021 · 2 comments

Comments

@smonff
Copy link
Contributor

smonff commented Mar 10, 2021

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
Copy link
Owner

tobyink commented Mar 10, 2021

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

Which parts do you think should be highest priority?

@smonff
Copy link
Contributor Author

smonff commented Mar 10, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants