Documentation request: maturity and guarantees

[pagrus7]

Context
Mockio looks quite promising in the landscape of golang mocking tools. Mockio builds on go-dyno.
For someone considering adoption of these beyond pet projects, there is an important question: how mature, future-proof and supported go-dyno is.

Two challenges are on the path to answering this question:

• Current docs describe go-dyno as "An attempt to bring java-like dynamic proxy to golang".
  • This language is not perfect for building confidence.
• Proxy impl uses mixture of reflection/unsafe/assembly with no docs or external references.
  • It's not immediately obvious whether/where the impl is based on specs & guarantees vs non-guaranteed impl details.

Doc request
This issue asks for docs to address or clarify the points above. E.g.:

1. Document the proxy impl, esp. guarantees and non-guarantees it relies on.
   • For guarantees, provide supporting references
2. Update project description to reflect the most-recent level of confidence by maintainers.
   • Depends on outcome of (1)
   • IMO ideally (1) would allow the description along the lines of "Fully guaranteed go implementation of dynamic proxies. No code generation required. Up to 249 args per function. Validated with [list of architectures]. Powers Mockio [and more references if available]."

[ovechkin-dm]

Hi @pagrus7,
Thanks for pointing that out.

I agree that the "attempt" word is not very reassuring. The library itself was written as a proof of concept at first, and unfortunately the description haven't changed since the start.
But now I am confident that I can support this library in a long run.
Since mockio is in a decent state for now (no major bugs, and all necessary features are present), I think I will focus on go-dyno for the next months.

Here is what I aim to do:

• Add github workflows
• More test coverage
• Documentation page similar to mockio docs (including full description of what language/ABI features have been used, and the possibility of breaking changes for them)

Right now there is only a brief description about supporting new go versions here:
https://ovechkin-dm.github.io/mockio/latest/limitations/

[ovechkin-dm]

#6
#7
#8