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

Standardize example documentation across repos #16

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Standardize example documentation across repos #16

wants to merge 6 commits into from

Conversation

libutcher
Copy link
Contributor

@libutcher libutcher commented Apr 10, 2024 •
edited
Loading

This PR standardizes the example folders across our repos. It includes the following changes:

  • Adds a README to introduce the example.
  • Edits the example code comments to include a bit more information and use the same wording as I've proposed in the other repos.

Closes #15

Questions:

  1. Is there any other information we should include in the README? For example, the JS example readme includes a command to run the JS examples.
  2. Should we call the folder "examples" like we do for JS, or do we anticipate only having a single example here?

@libutcher libutcher self-assigned this Apr 10, 2024
libutcher
libutcher commented Apr 10, 2024
View reviewed changes
example/example.py Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AndyTitu AndyTitu Awaiting requested review from AndyTitu

@sam-1pass sam-1pass Awaiting requested review from sam-1pass

At least 1 approving review is required to merge this pull request.

Assignees

@libutcher libutcher

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Standardize example code comments
1 participant
@libutcher