php / php/phd

Be more lax in function/methodnames tag in regards to whitespace

Open
#80 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
91
Forks
59
PR merge metrics
No merged PRs in 30d

Description

I recently fixed an issue on pt_BR where linking on <function> was failing because whitespace inside the tag. So I suggest trim() and strtolower() the tag's content before calculating link targets.

Originally posted by @alfsb in https://github.com/php/doc-en/issues/2658#issuecomment-1669890373

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

Start by locating the code that parses function/methodnames tags and calculates their link targets, then inspect any existing tests for this behavior. Reproduce a tag containing whitespace and mixed case, and consider the issue's proposed normalization. Done means such tags resolve the same link as trimmed, lowercase content, with tests covering the cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.