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

No Generator class #405

Merged
merged 40 commits into from
Dec 27, 2022
Merged

No Generator class #405

merged 40 commits into from
Dec 27, 2022

Conversation

lukew3
Copy link
Owner

@lukew3 lukew3 commented Dec 23, 2022

Will close #397

Not sure if this should be merged. See "Should this be merged?" section

What's in this pr

  • Removes generator class instantiation
  • Moves generator functions out of their own separate files and into their subject files
    • Removed func/<subject> directories and put generator functions in <subject>.py
  • ids are stored in ids.txt
    • Genlist is generated from this list
  • Added documentation created with pdoc

Should this be merged?

Pros:

  • Uses pdoc html instead of large github table
    • Github table currently takes a long time to load but may be easier to look at
    • Could do an entire other pros/cons of github readme vs pdocs
  • More conventional library structure?
  • Contributors don't have to manually determine id
    • Could just add the ids.txt file to current version to have this pro without the rest

Cons:

  • Many generator functions in each subject file
    • May be difficult to find a function
    • Would be easier to add nested subjects if each function is placed in nested subject folders instead of subject files.
  • Doesn't seem to offer significant speed improvements that were previously expected

Pros and Cons of Github docs vs pdoc

Github over pdoc

  • More friendly for beginner devs?
  • Saves a click, may be better for retention or to show what is possible
    • Could add a gif that shows the wide variety of problems that can be created
      • Quickly shuffle through frames showing a randomly generated problem
  • May be more difficult to generate sample problems for pdoc

Pdoc over github

  • Better layout, easier to nest subjects
  • Better documentation and explanation for each function
  • Don't have to wait for all of the mathjax to render in gh readme
    • could just make multiple subject readmes, but I think i would prefer pdoc over nabigating many gh readmes

Todo

Todo later

  • Create gif showcasing generators

@lukew3 lukew3 changed the title No instances No Generator class Dec 23, 2022
@lukew3 lukew3 merged commit a2d2a1b into main Dec 27, 2022
@lukew3 lukew3 deleted the no-instances branch January 5, 2023 21:24
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.

Fix long import times
1 participant