doctrine / doctrine/rst-parser

Better anchor URL for include reference

Open
#275 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
63
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Hello,

When a ref is in a included file which is used multiple time, generated anchor it's always the same and not the best.

I created a [phpunit reproducer](https://github.com/doctrine/rst-parser/compare/0.5.x...alamirault:rst-parser:multi-reference-same-file). Problem was found on https://github.com/symfony/symfony-docs/pull/18791#discussion_r1307678134

The reproducer branch, has also a second commit, which "fix" the behavior. Please, tell me if I can open a PR, or if there is a better alternative

Contributor guide

Open the contributing guide

Research direction

Start with the linked PHPUnit reproducer and compare the behavior between the 0.5.x branch and the multi-reference-same-file branch. Confirm how anchors are generated when one included file is reused, then verify that repeated references receive the intended distinct anchor URLs and that the reproducer passes with the proposed behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
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.