Skip to content

More cleanup for update_quick_index.py + helpers #2113

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

Merged
merged 15 commits into from
Jun 17, 2024

Conversation

pushfoo
Copy link
Member

@pushfoo pushfoo commented Jun 17, 2024

TL;DR: Organize doc helpers better and things like missing docstrings

Why?

TL;DR: Maintainability

  • Keep the quick index script lean by putting helpers elsewhere
  • Explain what the helpers are and how to use them

Changes

  • Make util/doc_helpers module
  • Move vfs-related items into it
  • Move misc reusable helpers into it (get_module_path, etc)
  • Fix docstring for VirtualFile
  • Consistently use pathlib.Path inside vfs-related classes
  • Minor style polishing

@pushfoo pushfoo changed the title Cleaning and documentation for update_quick_index.py + helpers More cleanup for update_quick_index.py + helpers Jun 17, 2024
@einarf einarf merged commit d420e34 into pythonarcade:development Jun 17, 2024
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