Skip to content

Docs: Use && instead of | in box-shadow syntax example #40298

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kannanwisen
Copy link
Contributor

@kannanwisen kannanwisen commented Jul 10, 2025

Description

This PR corrects the syntax comment in a box-shadow example, changing the incorrect | (OR) separator to && (AND) for better accuracy and clarity.

Motivation

The previous comment used /* | | */, which was misleading as it implied only one of the components could be used. Using && correctly signifies that these components are used together to form the shadow value. This change aligns the example with formal CSS value syntax and reduces potential confusion for developers reading the documentation.

Additional details

Related issues and pull requests

Fixes #39659

@kannanwisen kannanwisen requested a review from a team as a code owner July 10, 2025 11:24
@kannanwisen kannanwisen requested review from chrisdavidmills and removed request for a team July 10, 2025 11:24
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs size/s [PR only] 6-50 LoC changed labels Jul 10, 2025
Copy link
Contributor

Preview URLs

Flaws (5)

URL: /en-US/docs/Web/CSS/box-shadow
Title: box-shadow
Flaw count: 5

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/box-shadow-color
    • Can't resolve /en-US/docs/Web/CSS/box-shadow-offset
    • Can't resolve /en-US/docs/Web/CSS/box-shadow-blur
    • Can't resolve /en-US/docs/Web/CSS/box-shadow-spread
    • Can't resolve /en-US/docs/Web/CSS/box-shadow-position

@dipikabh
Copy link
Contributor

Hi @kannanwisen, thanks a lot for opening the PRs. (quick note: a single PR would have worked just fine instead of splitting the updates across 4 PRs :) )

Perhaps, my feedback in the issue you raised was not clear.

With a comment like the following already in place:
/* Three length values and a color */

we don't additionally need this line:
/* <length> | <length> | <length> | <color> */

So the comment containing | should be removed and it should not be replaced with /* <length> && <length> && <length> && <color> */.

@kannanwisen
Copy link
Contributor Author

Hi @dipikabh, thank you for the note about the pull requests. My apologies for creating multiple PRs;

For you feedback, I replied in #40301.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:CSS Cascading Style Sheets docs size/s [PR only] 6-50 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Grammar inconsistency in box-shadow syntax example: | vs. &&
2 participants