Expronicon.jl icon indicating copy to clipboard operation
Expronicon.jl copied to clipboard

request more examples of use

Open JeffreySarnoff opened this issue 3 years ago • 4 comments

As you have time, or some inspiration, additional examples and different kinds of use would go a long way to getting people more comfortable with this.

JeffreySarnoff avatar Apr 06 '21 06:04 JeffreySarnoff

not sure what kind of example you mean here? there are almost one example for each exported function and type already written in the doc. I'm not sure what example is missing, but if you find any would be nice to file an issue for that.

Roger-luo avatar Apr 06 '21 17:04 Roger-luo

Yes, your coverage of the exported functions is good. It seems to me that the real value of your package is to be realized when others combine and coordinate these exports to achieve something masterful and otherwise difficult to produce. My suggestion is that collecting some smaller examples that highlight both "ways of use" and "reasons for use" would be most helpful.

JeffreySarnoff avatar Apr 07 '21 06:04 JeffreySarnoff

It seems to me that the real value of your package is to be realized when others combine and coordinate these exports to achieve something masterful and otherwise difficult to produce.

It's a replacement of ExprTools/MacroTools/etc. using the modern pattern matching engine MLStyle. I believe this package already have much better documentation comparing to those

My suggestion is that collecting some smaller examples that highlight both "ways of use" and "reasons for use" would be most helpful.

I don't have any good small examples at the moment, especially the usage of metaprogramming can be very general, perhaps someone could contribute a few in the future. But I have added a use case page in the doc, now there is only one package Configuration depends on this package, but I'm planning to switch to this package for a few more packages of mine. These can serve as best practices.

However, I don't think one can/should do meta-programming without learning what's happening below the high-level interface - which means you still need to understand the Julia docs and basic knowledge of compilers first. This is because, unlike a machine learning model that you can just work on high-level wrappers, metaprogramming can be subtle, and to be responsible to your users, the developers should be aware of what's happening exactly.

Roger-luo avatar Apr 07 '21 21:04 Roger-luo

Thank you.

On Wed, Apr 7, 2021 at 5:09 PM Rogerluo @.***> wrote:

It seems to me that the real value of your package is to be realized when others combine and coordinate these exports to achieve something masterful and otherwise difficult to produce.

It's a replacement of ExprTools/MacroTools/etc. using the modern pattern matching engine MLStyle. I believe this package already have much better documentation comparing to those

My suggestion is that collecting some smaller examples that highlight both "ways of use" and "reasons for use" would be most helpful.

I don't have any good small examples, especially the usage of metaprogramming can be very general, perhaps someone could contribute a few in the future. But I have added a use case page in the doc, now there is only one package Configuration depends on this package, but I'm planning to switch to this package for a few more packages of mine. These can serve as best practices.

However, I don't think one can/should do meta-programming without learning what's happening below the high-level interface - which means you still need to understand the Julia docs and basic knowledge of compilers first. This is because, unlike a machine learning model that you can just work on high-level wrappers, metaprogramming can be subtle, and to be responsible to your users, the developers should be aware of what's happening exactly.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Roger-luo/Expronicon.jl/issues/8#issuecomment-815266526, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAM2VRRQHBSLMTRIKLTPJ4TTHTC2JANCNFSM42OCRLFQ .

JeffreySarnoff avatar Apr 07 '21 21:04 JeffreySarnoff