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

feat: Refactor --tldr Flag and Repair Test Suite #54

Merged
merged 24 commits into from
Nov 21, 2024
Merged

Conversation

gkapfham
Copy link
Collaborator

@gkapfham gkapfham commented Nov 21, 2024

  • feat(pyproject.toml): add name to the .toml file.
  • add(display.py): change the commands into a dictionary for long term maintainablitiy.
  • feat(main.py): change the tldr to set to false so that it can be disabled.
  • add(display.py): all the commands in the cli and also their descriptions
  • remove(display.py): the poetry command since it can be used with other dependencies.
  • remove(diosplay.py): remove the <> in the model and method
  • fix(display.py): fix the formatting by running ruff format.
  • add(display.py): the <> to the advice method for better readabitlity
  • fix(display.py): the advice-method for better clarity on how to run the coding mentor.
  • remove(display.py): the .toml file output for more user clarity
  • remove(display.py): examples
  • fix(pyproject.toml): change version to 0.3.2
  • remove(display.py): the 'run' infront of all commands because that is not needed
  • coms: Add comments to explain steps and reformat code in the execexam/display.py file.
  • coms: Fix a spelling mistake in a comment in the execexam/main.py file.
  • test: Add more tests for the command-line interface in the tests/test_main.py file.
  • test: Add a test for the --tldr flag of the command-line interface in tests/test_main.py.
  • coms: Add comments to tests/test_main.py.
  • test: Add test cases to tests/test_main.py for combination of --tldr and --help.
  • chore: Remove the coverage.json file as it is generated and then add coverage.json back to .gitignore.
  • coms: Add a NOTE reminder about how to perform testing with the tests/test_main.py file.
  • test: Add more tests for spelling mistakes of cli arguments in tests/test_main.py.

Pull Request

This PR adds test cases and makes other small improvements to PR #47. Please see that PR for more details about the features provided by this PR.

hemanialaparthi and others added 24 commits November 8, 2024 10:22
@gkapfham gkapfham self-assigned this Nov 21, 2024
@gkapfham gkapfham added the enhancement New feature or request label Nov 21, 2024
@gkapfham gkapfham merged commit 4f7c312 into main Nov 21, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants