Auto-CORPus icon indicating copy to clipboard operation
Auto-CORPus copied to clipboard

General cleaning and check of the code

Open Antoinelfr opened this issue 10 months ago • 1 comments

Describe the bug

  • Making the code less redundant and more professional (Better exception handling, rather than the global try-except currently used)
  • Ensuring the library works for all OS
  • Checking the requirements are well written for a new user to be able to use AC without error and maybe freeze some library versions to avoid bugs in the future
  • Poke holes in the documentation where information is unclear or missing and in the code when not enough comments are present to understand what is happening
  • Cleaning the GitHub project of irrelevant information, merge, PR issue and branch

Alex's audit (see below)

  • [ ] #135
  • [ ] #139

Bugs:

  • [x] #143
  • [x] #144
  • [x] #146

Antoinelfr avatar Mar 10 '25 14:03 Antoinelfr

I've written some notes based on a quick audit of the code I've done and a conversation with @AdrianDAlessandro. I figured it would be easiest if I put these in a comment here and then we can maybe go through it quickly in the next meeting. I'll open issues for things I think should be issues, purely for the sake of tracking them -- we won't necessarily have time for all of them and, in any case, they might not be things you want.

I'll try to add at least a bit of a description to each of the issues. Feel free to comment if you'd like more information or ask on Slack or in the meeting.

Edit: It turns out that in order to be able to make a list of things to turn into issues it has to be in the issue description, so I've stuck my todo list there. Hope that's ok @Antoinelfr.

alexdewar avatar Mar 14 '25 15:03 alexdewar