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

Sync the Usage section of README with mods --help #404

Open
gy-mate opened this issue Dec 14, 2024 · 2 comments
Open

Sync the Usage section of README with mods --help #404

gy-mate opened this issue Dec 14, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@gy-mate
Copy link
Contributor

gy-mate commented Dec 14, 2024

Describe the bug

The difference between using mods...

  • with the -P flag
  • with the -p flag
  • without any flags

...when piping a text to the command isn't clear to me. I think that this should be clarified in README.md and features.md.

Setup

  • OS: macOS 15.2
  • Shell: zsh
  • Terminal Emulator: Warp
  • Terminal Multiplexer: N/A

To Reproduce

All the following commands result in basically the same answer:

echo "class Subway:" | mods "Please write me an __init__() for this class."
echo "class Subway:" | mods -p "Please write me an __init__() for this class."
echo "class Subway:" | mods -P "Please write me an __init__() for this class."

Additional context

As asked here: https://discord.com/channels/1032368467246075914/1032368467988451425/1314985081030578247

@caarlos0 caarlos0 added the documentation Improvements or additions to documentation label Jan 14, 2025
@caarlos0
Copy link
Member

what do you feel is insufficient about mods --help in that regard?

@gy-mate
Copy link
Contributor Author

gy-mate commented Jan 18, 2025

@caarlos0 Sorry, I didn't spot the difference between that and https://github.com/charmbracelet/mods#usage. I think that the latter should be updated to show the same as mods --help.

@gy-mate gy-mate changed the title Clarify difference between piping text to mods with -p, -P or no flags Sync the Usage section of README with mods --help Jan 18, 2025
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
Projects
None yet
Development

No branches or pull requests

2 participants