Skip to content
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

Make behavior of PHP and GitHub references consistent #191

Merged
merged 1 commit into from
Apr 7, 2025

Conversation

wouterj
Copy link
Contributor

@wouterj wouterj commented Apr 6, 2025

Changes

  • Make escaping consistent for PHP and Github references (require double backslashes, as single can be used to escape the ` character).
  • Add namespace support to :phpmethod: (consistent with :method: and :phpclass:)
  • Update PHP reference text/title to be consistent with GitHub references (e.g. strip the full namespace & only show method name)
  • Use String component in all reference classes

The updates should be fully compatible with Symfony documentation. symfony/symfony-docs#20822 is the only case where we use the new namespace features of :phpclass: (and this revealed the inconsistency).

Copy link
Collaborator

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! Thanks Wouter.

@OskarStark OskarStark merged commit 44b5818 into symfony-tools:main Apr 7, 2025
3 checks passed
@wouterj wouterj deleted the phpclass-consistent branch April 7, 2025 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants