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

refactor examples repo #6

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

refactor examples repo #6

wants to merge 7 commits into from

Conversation

verbose-void
Copy link

@verbose-void verbose-void commented Oct 7, 2021

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)

Copy link
Member

@davidbuniat davidbuniat left a comment

Choose a reason for hiding this comment

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

  • Please bring collabs, they are directly linked to everywhere and become our single source of truth
  • rename hub_examples to examples or have them on higher repository.
  • Why have you removed getting started?

@verbose-void
Copy link
Author

@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

@verbose-void
Copy link
Author

@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.

@verbose-void
Copy link
Author

@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)

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