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

Docs: Link to Go Client documentation #15

Open
jimpick opened this issue Apr 6, 2020 · 0 comments
Open

Docs: Link to Go Client documentation #15

jimpick opened this issue Apr 6, 2020 · 0 comments

Comments

@jimpick
Copy link
Member

jimpick commented Apr 6, 2020

All of the JSON-RPC methods callable from the Go client are listed here:

https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go

Godoc.org automatically publishes any inline documentation, for example:

The methods are currently lacking the comments that godoc uses. Here is a blog post describing how to document go code:

https://blog.golang.org/godoc

The JS Client documentation will probably share many descriptions with the go and JSON-RPC documentation. Ideally there would be an easy way to jump to the go documentation for a particular method from the JS documentation. This might be particularly helpful in the beginning before the entire API has been wrapped.

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

1 participant