Skip to content

docs: surround remediation flags with backticks for prompted feedback #135

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.

Sign up for GitHub

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

Merged
mwbrooks merged 1 commit into from
Jun 19, 2025
Merged

docs: surround remediation flags with backticks for prompted feedback #135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion internal/slackerror/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -729,7 +729,7 @@ Otherwise start your app for local development with: %s`,
Code: ErrFeedbackNameRequired,
Message: "The name of the feedback is required",
Remediation: strings.Join([]string{
"Please provide a --name <string> flag or remove the --no-prompt flag",
"Please provide a `--name <string>` flag or remove the `--no-prompt` flag",
Copy link
Member

@mwbrooks mwbrooks Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: It's a new dimension for us to write error messages with markdown docs rendering in mind. We'll also want to ensure this always looks good on the terminal. Back ticks can be a dangerous character in the terminal when copy & pasted, but I agree that it reads well.

question: We may be able to update our slack docs command to render &nbsp; instead of < rather than adding backticks to our error messages.

Copy link
Contributor Author

@lukegalbraithrussell lukegalbraithrussell Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh i just went ahead and added the backticks because i saw them in other errors -- if it creates issues i can add an exception on our docs-cleaning scripts instead. i was trying to avoid adding hardcoded examples in that for maintenance reasons, but if it actually affects terminal output possibilities then it seems like the better option!

Copy link
Member

@zimeg zimeg Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Adding to @mwbrooks suggestion - I lean towards improving docgen outputs with expected escaping for these cases!

But I do think this change makes the remediation more clear, FWIW.

Copy link
Member

@mwbrooks mwbrooks Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lukegalbraithrussell Totally cool! I think we should merge this PR because it immediately fixes the docs experience. We can create a task to improve the docgen command if we want to avoid adding back ticks to every occurrence of < and >. :shipit:

fmt.Sprintf("View feedback options with %s", style.Commandf("feedback --help", false)),
}, "\n"),
},
Expand Down
Loading