Standardize example documentation across repos #16

libutcher · 2024-04-10T15:00:55Z

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:

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.
Should we call the folder "examples" like we do for JS, or do we anticipate only having a single example here?

example/example.py

libutcher added 4 commits April 10, 2024 10:38

Rename to "examples" to match JS

5d56bea

Add README

957284e

Code comment edits

e5040ce

README edits

38e944a

libutcher self-assigned this Apr 10, 2024

Revert folder name change

3ba6753

libutcher commented Apr 10, 2024

View reviewed changes

example/example.py Outdated Show resolved Hide resolved

Fix spacing

5c9024d

libutcher requested review from AndyTitu and sam-1pass April 10, 2024 15:06

Provide feedback