General revamp and tidy up #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
At least for now. I wrote that with Sphinx-a-like docstrings in mind, but I'm moving this code over to Google style docstrings.
Use list and tuple rather than List and Tuple, etc.
I think it's finally time to admit that my style of "significant thing" marker makes less sense these days, especially given I've been leaning into and properly using docstrings for a long time in Python. OTOH I can't quite do without the visual cue that there's an important thing happening here. So, for my own code, let's try a simple "line to say there's a thing here" approach. Could play well in minimaps too. Also fixing up some more docstrings here too.
This doesn't do anything yet -- I need to set to on writing the intro in the docs and thinking about a good layout, etc. But this should set up the environment so I'm good to go.
I'm not 100% sure this is going to work; I need to try this out with different Python versions. From what I can see it should work; but on the other hand Vermin isn't convinced -- but I don't know if it knows enough to do the right thing.
Remove types where I've used them before, there's no real need for them.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's been a wee while since I last worked on this code, I want to tidy it up and start to build an application atop of it. So here I bring it more in line with how I have my Python repos these days,