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

Formatting changes, update imports, other minor changes #227

Merged
merged 8 commits into from
Nov 19, 2024

Conversation

glass-ships
Copy link
Member

@glass-ships glass-ships commented Nov 14, 2024

This PR aims to include several auxiliary changes made in the Restructure PR #185, but without the restructure itself. Includes things like:

  • Formatting
  • Updating imports
  • Renaming tests to the pytest standard of test_<test name>.py

along with some other small random changes.

Should be overall an unobtrusive set of changes.

@glass-ships
Copy link
Member Author

glass-ships commented Nov 14, 2024

Unclear why a few doc tests are failing.

Fixed

@glass-ships glass-ships marked this pull request as ready for review November 15, 2024 14:32
doc/pylit.py Outdated
Copy link
Member

Choose a reason for hiding this comment

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

I honestly don't know what this file is for.

Copy link
Member Author

Choose a reason for hiding this comment

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

the only other place pylit gets used is in gentut.py, but I dont think it references this file. safe to delete?

Copy link
Member

Choose a reason for hiding this comment

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

I don't completely understand how the documentation gets created, tbh. Is there any chance sphinx makes stuff from here?

Copy link
Member Author

Choose a reason for hiding this comment

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

I believe sphinx references conf.py which calls gentut.py to generate the tutorials. but gentut.py just imports pylit, which is just a direct copy of an old version of https://codeberg.org/milde/pylit/src/branch/master/pylit.py

We can either leave pylit.py as it is, or delete it and add pylit to the pyproject.toml as a dev dependency.

I tested the latter option, and it seems to work just fine, so either option would be fine. Dealer's choice

Copy link
Member

@bmaranville bmaranville left a comment

Choose a reason for hiding this comment

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

Looks really good - a few minor changes suggested inline.

@glass-ships
Copy link
Member Author

Sweet - comments have been addressed!

@bmaranville bmaranville merged commit 0055e50 into master Nov 19, 2024
10 checks passed
@glass-ships glass-ships deleted the glass-patch-1 branch November 19, 2024 16:17
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