Fix cog templates to generate correct command name in docs and rewrite README#45
Conversation
Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>
Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>
|
@copilot rewrite README.md to reflect the current state of the application. Provide a summary overview of last.fm, scrobbling, and the last.fm api. Summarize the top level commands and point to documentation as needed. If it makes sense revise and keep the current README.md text. Be sure to credit the original author and make sure there's a note reflecting the current open source license. |
Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>
Rewrote README.md with comprehensive content (commit 1a4e13f):
The README is now comprehensive (240+ lines) while keeping the original's acknowledgment to Jacob Kaplan-Moss and maintaining clear links to the command documentation. |
* Fix cog templates to generate correct command name in docs and rewrite README (#45) * Initial plan * Update cog snippets in all doc files to use prog_name='scrobbledb' Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com> * Regenerate docs with scrobbledb instead of cli Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com> * Rewrite README.md with comprehensive overview and documentation Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com> Danger! Danger! High Voltage! * Word wrapping, updating license information --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Danger! Danger! High Voltage!
Generated documentation showed
Usage: cliinstead ofUsage: scrobbledbin all command help text.Changes
prog_name='scrobbledb'toCliRunner.invoke()poe docs:cliTechnical Detail
Click's
CliRunner.invoke()defaults to using the function name as the program name. The fix:This changes the generated output from:
To:
README.md Rewrite
Expanded the minimal 17-line README into a comprehensive 240+ line document that includes:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.