Skip to content

chore: Fix capitalization on placeholder

Amy Qualls requested to merge 1530-update-placeholders-snippets into main

Description

I'm opening this MR with a small change, so I can have the opportunity to ask questions. In the gitlab repo docs, when we talk about a field, we print the exact text shown to the user, and bold it.

In gitlab!169195 (merged), I was writing out the full steps for all snippets-related procedures in the VS Code extension.

  • I noticed that the placeholder text for patch name was all lower-case, so I started by fixing that.
  • When the user is asked to select from a list, like for snippet privacy, no explanatory text is shown. Can we set placeHolder: 'Privacy level' for a vscode.window.showQuickPick like you can vscode.window.showInputBox?
    • We assume the user understands what they're choosing, but we shouldn't make that assumption.
    • It's probably also an accessibility problem.
    • It also gives me an exact string to refer to in the docs. (I found a workaround for gitlab!169195 (merged).)

The comment I made to Brendan in gitlab!169195 (comment 2158347703) is the end result of having no text I can reference.

Related Issues

How has this been tested?

Screenshots (if appropriate)

What CHANGELOG entry will this MR create?

  • fix: Bug fix fixes - a user-facing issue in production - included in changelog
  • feature: New feature - a user-facing change which adds functionality - included in changelog
  • BREAKING CHANGE: (fix or feature that would cause existing functionality to change) - should bump major version, mentioned in the changelog
  • None - other non-user-facing changes
Edited by Amy Qualls

Merge request reports