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

Refactoring effort #1

Open
11 of 12 tasks
svhawkins opened this issue Sep 7, 2023 · 7 comments
Open
11 of 12 tasks

Refactoring effort #1

svhawkins opened this issue Sep 7, 2023 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@svhawkins
Copy link
Owner

svhawkins commented Sep 7, 2023

Currrent code can be done better, you've gotten better at Python since you originally wrote it (more than a year ago). Can be done by doing the following:

  • Go through the # TODO, # FIXME, and # BUG comments and resolve them
  • Add testing fixtures and unit tests using pytest for modules:
    • verb_utils.py
    • conjugator_utils.py
    • verbs.py
    • conjugator.py
  • Add better comments for modules, class names, class attributes, class functions and other function defintions to better match that of a documentation string.
    • verb_utils.py
    • conjugator_utils.py
    • verbs.py
    • conjugator.py
  • Add type hints for better clarity for every module
@svhawkins svhawkins self-assigned this Sep 7, 2023
@svhawkins svhawkins added the documentation Improvements or additions to documentation label Sep 7, 2023
@svhawkins
Copy link
Owner Author

2023.10.11::00:16: refactored and tested verb_utils.py. added comments to suggest having it as a singular class instead of many functions.

@svhawkins
Copy link
Owner Author

2023.10.29::14:00: refactored and tested verbs.py. Had to modify the refactored verb_utils.py a bit. There is a still a bug with the soften, lengthen, shorten, and harden functions, but there usage is now limited/avoided.

@svhawkins svhawkins mentioned this issue Oct 29, 2023
@svhawkins svhawkins added the enhancement New feature or request label Oct 31, 2023
@svhawkins
Copy link
Owner Author

2023.11.02::23:29: added type hints and better documentation style strings for the modules: providing module, class, and function descriptions.

@svhawkins
Copy link
Owner Author

2023.11.04::22:23: completed refactoring of verb classification, leaving only disambiguation to be refactored and tested. There are still a few minor issues one such being that a certain verb class is classified based only on ending but should also be classified on its syllabilacity. Another issue is that some 'special cases' (not irregular, just a change in a letter or 2) require the unprefixed verb.

@svhawkins
Copy link
Owner Author

svhawkins commented Apr 17, 2024

2024.04.17::02:20: completed refactoring of conjugation utilities with completion of verb disambiguation and concrete verb determination. There is still work to be done in determining a verb's aspect (heuristically?), but where it stands now it surpasses the prior implementation.

conjutils_refactor is to be merged to main and future work will be on the branches conjugator_tests and perfective.

@svhawkins
Copy link
Owner Author

svhawkins commented Apr 21, 2024

2024.04.21::15:06: conjugator testing for the most part done. There is still a single BUG comment and a few TODOs (all for aspect). FIXMEs were resolved. Branch conjugator_tests has been merged to main.

@svhawkins
Copy link
Owner Author

2024.04.22::19:02: Fixed vutils bug in the convert_last_match() function, now only converting at the last occurence in the last syllable. Resolving #4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant