Remove cruft from modules #1402
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
|
Pushed back to 7.0.0, so I can focus on the last remaining "more important" fixes for 6.6.0. |
The `log_line` regex was orphaned in ab05f11 and hasn't been used since. That was almost five years ago. No `re` stuff needed in the module now.
Actually, it's from 6 years ago now. — dgw, rebasing onto current master Co-Authored-By: dgw <dgw@technobabbl.es>
Really did a number on the docstrings here. Will probably have to update a pending PR or two based on these changes…
Also added `help_prefix` to usage outputs.
Added a missing command docstring, too.
It felt good to address that TODO comment from years ago.
Unified style of header with the other modules. Had to guess at year of authorship by browsing to the Phenny repo (but the module might be older even than that). Also added a couple more punctuation options for `hello()` to use.
On top of updating the comment pointing to the pronoun.is JSON API pull request we'd like to see merged (the old one was merged into a feature branch), this also fixes some typos and handles the example commands properly using the help prefix set in the bot's config. Oh, and it also removed an unused global logger. You know, actual cruft.
Use myself (current maintainer) as example, instead of old maintainer who probably doesn't want to be bothered (or highlighted in case someone happens to get that help output in a channel where they are). Sort imports, rename global constant to UPPERCASE, and add a bit of future-thinking documentation for in-progress work.
Renamed memory key from "uptime" to "start_time", since it's actually storing the bot's start time and not its uptime. Tweaked some other code/docstring style, too.
Prettified file header, added missing docstring(s), etc.
Overhauled docstrings and sorted imports while looking for unused code.
At some point in the future, we want to enforce good import order. Standard imports before modules, and external packages before our own, that kind of thing. Since I'm going through all the modules anyway, sorting the imports makes sense to reduce the workload later.
Overhauled import order and docstrings while looking for unused code.
A blank line between standard and module imports is nice. Not enforced (yet), but nice to have. Also, since we're using UTF-8 for this source file, why did we not output a Unicode '…' ellipsis instead of '...' three periods? We do now.
I came looking for cruft, but the closest thing I found was outdated comments referencing "google" even though we haven't used Google for years. (It was DuckDuckGo for a while, but now it's Bing, because DDG broke using multiple `site:` queries and never fixed the bug.) So, now we just talk vaguely about searching the web, instead of Google. We also have a nicer module-level docstring, which is part of the cruft-cleaning project as well.
|
This is now ready for eyes. There are a lot of little changes, so take your time! |
Exirel
approved these changes
Apr 16, 2019
|
@dgw just 🚢 it 😉 |
This was referenced Apr 22, 2019
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.
What started as a fixup in #1400 (noticing that a regex string literal I corrected to pass new style checks was actually unused) turned into a longer-term project to go through all the modules and remove old, orphaned cruft that isn't needed any more.
The
versionmodule is the first to receive this attention, and I'll check the rest after Hacktoberfest ends.