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

Docs: Suggestion: Make the need for <?php on error docs pages more obvious #8139

Open
ThomasLandauer opened this issue Jun 21, 2022 · 1 comment

Comments

@ThomasLandauer
Copy link
Contributor

On pages like https://psalm.dev/docs/running_psalm/issues/PossiblyNullArgument/, there needs to be a code block containing the <?php tag, and it needs to emit the respective error.
This is what I learnt at #8135 (comment)

While such a check is certainly a good thing, it could be made more obvious for docs contributors.

Idea: Change the tag to:

<?php // code for NameOfTheTestThatAssertsIt, see https://...

... linking to some docs page that explains it. And make the parser (that generates the final HTML page) remove it.

@AndrolGenhald
Copy link
Collaborator

Why not just add a comment to the docblock for the test? The test itself is the first place you should look when you notice it's failing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants