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

Documentation should provide example callers. #184

Closed
gmaxwell opened this issue Jan 11, 2015 · 3 comments · Fixed by #748
Closed

Documentation should provide example callers. #184

gmaxwell opened this issue Jan 11, 2015 · 3 comments · Fixed by #748
Assignees
Labels
user-documentation user-facing documentation

Comments

@gmaxwell
Copy link
Contributor

We've seen some people attempting to use the library calling into random internal functions. That should be harder to do now... but now that the basic signature interface is relatively safe to use (as such things go) there should be some easy copy and paste examples for correct usage.

@gmaxwell gmaxwell added the user-documentation user-facing documentation label Jan 11, 2015
@gmaxwell gmaxwell self-assigned this Jan 11, 2015
@gmaxwell gmaxwell added this to the initial release milestone Aug 27, 2015
@jonasnick
Copy link
Contributor

As an example we have someting like this in secp256k1-zkp to demonstrate musig: https://github.com/ElementsProject/secp256k1-zkp/blob/secp256k1-zkp/src/modules/musig/example.c

@nickfarrow
Copy link

For anyone else interested in how to generate keys using this library, feel free to checkout my Bitcoin vanity address generator which I think provides a short and reasonably well commented example of how to generate private and public key pairs.

@jonasnick jonasnick changed the title Docucmentation should provide example callers. Documentation should provide example callers. Apr 28, 2020
@jonasnick
Copy link
Contributor

I'd suggest to add a short and well documented example source file for every module and build and run it as part of make check. We can list the modules in the README and from there link to the examples and include files for more documentation.

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

Successfully merging a pull request may close this issue.

3 participants