feat: refactor --tldr flag

[hemanialaparthi]

feat: Updated TLDR flag

1. Enhance TLDR Command Examples with Realistic Usage Patterns

This update makes the --tldr output more practical and easier to maintain while following established documentation conventions.

2. List the names of those who contributed to the project.
@hemanialaparthi

3. Link the issue the pull request is meant to fix/resolve.
#39

4. Add all labels that apply. (e.g., documentation, ready-for-review)
bug, enchancement, ready-for-review

5. Describe the contents and goal of the pull request.
This PR improves the --tldr feature by making the command examples more practical and maintainable:

• Restructure command examples into a dictionary format for better code organization
• Remove Poetry-specific prefixes for broader applicability
• Replace abstract placeholders (like ) with concrete, realistic examples

These changes align our documentation style with established conventions like tldr-pages, making the examples more immediately useful for users.

6. Will coverage be maintained/increased?
This feature will not need coverage so coverage will be maintained.

7. What operating systems has this been tested on? How were these tests conducted?
This has been tested on mac, would appreciate testing on linux and windows.

8. Include a code block and/or screenshots displaying the functionality of your feature, if applicable/possible.

The command: poetry run execexam --tldr

The NEW intended output:

[rebekahrudd]

I ran this on Linux.

My output was formatted a little differently but it still works and completes the intended job. Here is my output:

Something to consider is that the red output that says to make sure I am in a directory with a pyproject.toml file makes me think that I'm not in that directory. It makes me think there's an error when there isn't one.

[hemanialaparthi]

I ran this on Linux.

My output was formatted a little differently but it still works and completes the intended job. Here is my output:

Something to consider is that the red output that says to make sure I am in a directory with a pyproject.toml file makes me think that I'm not in that directory. It makes me think there's an error when there isn't one.

Hey @rebekahrudd! This is the output of the old --tldr flag. You might want to use the new branch and doing poetry update to get the changes

[PCain02]

I got the output on Windows 10 that looks good. However, I will say I did poetry update and I got the same red output as @rebekahrudd and I agree it does make it a little confusing.

[PCain02]

Here is the line @rebekahrudd and I are referring to with the red output.

[hemanialaparthi]

I get how this could be confusing! I just removed it, could you please check it out again? Thanks!

[hannahb09]

I got it to work on linux.

[gkapfham]

Hello @hemanialaparthi will you need to update the pyproject.toml file?

[hemanialaparthi]

Hello @hemanialaparthi will you need to update the pyproject.toml file?

Hi @gkapfham! Yes, I did update the pyproject.toml file with my name as one of the authors and also bumped up the version to 0.3.2

[PCain02]

LGTM!

[CalebKendra]

the command is just execexam not run execexam. Change this string and it looks good!

[hemanialaparthi]

the command is just execexam not run execexam. Change this string and it looks good!

Thanks! I just changed it.

[CalebKendra]

LGTM

[gkapfham]

Hi @hemanialaparthi I have implemented the feature that removes the extra space. I am going to try to resolve the test that is not passing on NixOS. I will then commit that to this PR and then confirm that everything still passes. If this works then we will need to update the PR #41 so that it has my upgraded version of the test.

[hemanialaparthi]

Hi @hemanialaparthi I have implemented the feature that removes the extra space. I am going to try to resolve the test that is not passing on NixOS. I will then commit that to this PR and then confirm that everything still passes. If this works then we will need to update the PR #41 so that it has my upgraded version of the test.

Awesome! Thank you for letting me know!

[gkapfham]

Note: learned from @PCain02 that the test failed in the same way on Windows before it was patched.

[gkapfham]

Hi @PCain02 and @hemanialaparthi I'm nearly finished with work on test cases that will pass. I will make sure that everything works and then merge this PR as soon as my schedule permits. Thanks for your help and hard work!

[hemanialaparthi]

Hi @PCain02 and @hemanialaparthi I'm nearly finished with work on test cases that will pass. I will make sure that everything works and then merge this PR as soon as my schedule permits. Thanks for your help and hard work!

@gkapfham, thank you for working on this!!

[PCain02]

Hi @PCain02 and @hemanialaparthi I'm nearly finished with work on test cases that will pass. I will make sure that everything works and then merge this PR as soon as my schedule permits. Thanks for your help and hard work!

Awesome! Let me know if there are any issues or things I can help with!

[gkapfham]

Hi @hemanialaparthi please refer to PR #54 for an extension of this PR that takes into account all of your work and then extends it with new tests and repairs to the way in which other tests are run.