function.preg-match does not reference that input string length is limited to pcre.backtrack_limit

Open Beginner friendly
#4,526 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
php
Domain
documentation

Research direction

Start at the preg_match manual page linked in the issue and review the description of the $subject parameter. Document explicitly that an overly long subject is subject to pcre.backtrack_limit and may cause the function to fail. The work is done when this limitation is clear on the page.

Written by the indexing model from the issue text.

Description

From manual page: https://php.net/function.preg-match

If the $subject parameter is too long, this function will fail. It is subject to pcre.backtrack_limit, but this is not referenced on the page.

It would be useful if the subject parameter documented this explicitly.

See another user who ran into the same mysterious problem: https://stackoverflow.com/questions/4180910/#comment92414114_4180924

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

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.

More from php/doc-en

All issues in php/doc-en

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.