examples icon indicating copy to clipboard operation
examples copied to clipboard

refactor examples repo

Open verbiiyo opened this issue 4 years ago • 3 comments

remove how-to and docs information from README (it's harder to maintain 2 copies of this, so the README for examples should be distinct from the main repo)

verbiiyo avatar Oct 07 '21 03:10 verbiiyo

@davidbuniat i removed getting started as per the PR description, it's simply too hard to maintain multiple copies of documentation and it makes no sense to have docs in our examples repo. we should save the readme space for important information for examples

verbiiyo avatar Oct 09 '21 23:10 verbiiyo

@davidbuniat we shouldn't call the package "examples" because if we decide to make it a python package (which i think we should), the python package will be called "examples" but that's likely taken and confusing for users.

verbiiyo avatar Oct 09 '21 23:10 verbiiyo

@davidbuniat im not done with the PR yet, i plan on migrating notebooks but i want to find a better way to enforce readability (most of the notebooks/scripts in here are pretty poor readability) so a standard is necessary. also, all code here should be tested, so i think i will either #1 remove all notebooks in favor of well-written python scripts or #2 have a good solution for testing notebooks (something like this might work https://discourse.jupyter.org/t/how-to-run-a-notebook-using-command-line/3475)

verbiiyo avatar Oct 09 '21 23:10 verbiiyo