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.

Sign up for GitHub

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

Jump to bottom

Document cairo-rs API #1234

Open
pefontana opened this issue Jun 14, 2023 · 1 comment
Open

Document cairo-rs API #1234

pefontana opened this issue Jun 14, 2023 · 1 comment
Assignees
@fmoletta
Labels
documentation Improvements or additions to documentation

Comments

@pefontana
Copy link
Member

Make a doc with the APIs of cairo-rs, giving examples.
Also, document how the user should report errors
@pefontana pefontana added this to the 0.6.0 milestone Jun 14, 2023
@Oppen
Copy link
Member

Oppen commented Jun 19, 2023

Suggestion: the canonical way to do this is with doc comments (the triple /) in the source code. It's able to include and compile examples as well.
A more "tutorial-like" document can be made with mdbook as well.

@fmoletta fmoletta linked a pull request Jun 23, 2023 that will close this issue
Document public api #1278
Closed
6 tasks
@igaray igaray added the documentation Improvements or additions to documentation label Jan 15, 2024
@igaray igaray removed this from the 0.6.0 milestone Jan 15, 2024
@fmoletta fmoletta changed the title Documente cairo-rs API Document cairo-rs API May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fmoletta fmoletta

Labels
documentation Improvements or additions to documentation
Projects
Starknet
Status: Backlog
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document public api lambdaclass/cairo-vm
4 participants
@igaray @Oppen @pefontana @fmoletta