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

Remove duplicate examples and only keep one example from docs in the examples directory #74

Merged
merged 1 commit into from
Nov 22, 2022

Conversation

tohrnii
Copy link
Contributor

@tohrnii tohrnii commented Nov 15, 2022

This PR removes duplicate airscript files from examples directory and adds one example from the docs to the examples directory. Also includes a tiny fix for a rendering issue in the docs.

Copy link
Contributor

@grjte grjte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tohrnii this looks great, and thanks for catching the rendering error!

I think the only thing that's missing is that all examples related to the CLI need to be updated to use example.air instead of system.air.

I think this happens in the docs and in some of the READMEs, so the best thing is probably to search the entire repo for system.air

@grjte
Copy link
Contributor

grjte commented Nov 15, 2022

minor nit: I just noticed that the commit message is longer than one line. In this case, it would be great if you can shorten it so it fits in the summary line, but then add more detailed bullet points below it, e.g.

chore: update AirScript examples

- remove examples that are included in integration tests
- add a file with the example from the docs

- remove examples that are included in integration tests
- add a file with the example from the docs
@tohrnii
Copy link
Contributor Author

tohrnii commented Nov 22, 2022

Thank you @grjte for the review. Made suggested changes.

@tohrnii tohrnii requested a review from grjte November 22, 2022 14:39
Copy link
Contributor

@grjte grjte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thank you!

@tohrnii tohrnii merged commit 016f0d0 into 0xPolygonMiden:next Nov 22, 2022
@tohrnii tohrnii deleted the remove-examples branch November 22, 2022 14:44
@tohrnii tohrnii mentioned this pull request Nov 25, 2022
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

Successfully merging this pull request may close these issues.

2 participants