php / php/doc-en

Strings documentation regarding backslash

Open
#1,804 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
XML
Stars
596
Forks
890
Avg merge
1d 15h
Merged PRs (30d)
55

Description

ref: https://www.php.net/manual/en/language.types.string.php

The description under “Single quoted” says, “To specify a literal backslash, double it (\);” however, in the example we see...

// Outputs: You deleted C:\*.*?
echo 'You deleted C:\*.*?';

... so it seems it is not necessary to double the backslash. Should the instruction for doubling a literal backslash be removed from this section? Alternately, it could be clarified to state that doubling the backslash is optional, and either a single or double backslash will result in a single backslash.

In the “Double quoted” section we see, “As in single quoted strings, escaping any other character will result in the backslash being printed too.” This statement references a table of escaped characters that applies to double quoted strings, but not single quoted strings. I would cut the phrase “As in single quoted strings...” to avoid leading people to think that the table has anything to do with single quoted strings. It's clear enough to say, “Escaping any other character will result in the backslash being printed.”

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the Single quoted and Double quoted sections of the PHP language.types.string documentation linked in the issue, comparing their wording with the examples and escape-character table. Clarify the backslash behavior and remove the misleading cross-reference, then verify that the revised text matches PHP's documented string behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.