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

Clarify Choice Using Pipe Symbol (|) #56603

Closed
wants to merge 1 commit into from

Conversation

sojinsamuel
Copy link

@sojinsamuel sojinsamuel commented Oct 9, 2023

Replace / with | to indicate the file options clearly. it is confusing and could be misunderstood.

Screenshot (7)

Its obvious that files can't be nested. but while reading, i stopped for a couple of seconds and assumed it was a mistake in the docs, then while comparing with file paths, rather than the obvious. what i found is the space around the / when treated as an OR and no surrounding spaces when treated as a file path. I want beginners like me to understand the intend at a glance.

Let's make it clear. this is an OR

Replace '/' with '|' to indicate the file options clearly. it is confusing and could be misunderstood
@sojinsamuel sojinsamuel requested review from a team as code owners October 9, 2023 08:54
@sojinsamuel sojinsamuel requested review from manovotny and Nutlope and removed request for a team October 9, 2023 08:54
@manovotny
Copy link
Contributor

@sojinsamuel thanks for pointing this out to us. We're going to close this PR and take care of all instances in #56712 instead.

@manovotny manovotny closed this Oct 11, 2023
kodiakhq bot pushed a commit that referenced this pull request Oct 12, 2023
Based on feedback from #56603, the `/` can be interpreted as file paths instead of filename separators / delimiters. We'll change them to use pipes `|` instead.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 26, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants