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

Improve the readability of Adapt #130

Open
clusterfudge opened this issue Apr 26, 2021 · 0 comments
Open

Improve the readability of Adapt #130

clusterfudge opened this issue Apr 26, 2021 · 0 comments

Comments

@clusterfudge
Copy link
Collaborator

Adapt has two core readability problems:

First, an attempt to provide docstrings to the repository was disastrous. The documentation makes very little sense in isolation, and there is no top-level documentation that pulls it all together.

Second, the code is rife with poor programming practices, like single-letter variable names, which only exacerbate the first issue.

The remediation of this issue will likely span multiple changes. It's possible that the best outcome is a refactor towards typing (as opposed to the nested dict/tuple kerfuffle that exists today. The best outcome is not a requirement for closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant