Skip to content

[Bug] The documentation of the Pcntl\QosClass enum shows a broken synopisps #4516

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

Open
stof opened this issue Mar 6, 2025 · 0 comments · May be fixed by #4518
Open

[Bug] The documentation of the Pcntl\QosClass enum shows a broken synopisps #4516

stof opened this issue Mar 6, 2025 · 0 comments · May be fixed by #4518
Labels
bug Documentation contains incorrect information

Comments

@stof
Copy link
Contributor

stof commented Mar 6, 2025

Affected page

https://www.php.net/manual/en/enum.qosclass.php

Issue description

Image

this documentation has several issues:

  • it does not make it clear that this enum is not in the top-level namespace but in the Pcntl namespace
  • cases are broken as they all have a Pcntl:: prefix that does not make any sense (and is invalid syntax in PHP)

Steps to reproduce

  1. Go to https://www.php.net/manual/en/enum.qosclass.php

Suggested fix

Cases should be rendered without the broken prefix.
For the namespace, I would suggest rendered a namespace Pcntl; statement above the enum. This seems the sensible way to render a synopsis for a namespaced enum (or class)

@stof stof added the bug Documentation contains incorrect information label Mar 6, 2025
Girgias added a commit to Girgias/doc-en that referenced this issue Mar 6, 2025
@Girgias Girgias linked a pull request Mar 6, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Documentation contains incorrect information
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant