-
Notifications
You must be signed in to change notification settings - Fork 79
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
Documentation for exported APIs #859
Comments
YAGNI suggests that may be we just do it by hand for launch, and then figure out where the pain is later and determine where and how we want to put the effort into maintaining it. |
longfei is working on it |
@TippyFlitsUK could you please help move https://github.com/longfeiWan9/BuiltIn-Actor-API to here can be in a folder |
Hold on, can we discuss this? I've had a brief look at those docs. They look like they could be mostly generated from the code by some automation? Were they?
|
|
There's no direct documentation of the built-in actors exported APIs. There's only little documentation of any API, but that's been tolerable to date because the set of users is small and generally has high context already.
We should develop some kind of decent quality documentation of the syntax and semantics of APIs callable by other actors or smart contracts. Immediate motivation for this comes from EVM developers, but there's nothing EVM-specific about this documentation (I'd expect EVM library authors could derive much of their documentation from ours, though).
It's not immediately obvious what the best way to do this is.
FYI @arajasek @raulk @ZenGround0
The text was updated successfully, but these errors were encountered: