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

Move PHPT documentation to docs #15939

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Move PHPT documentation to docs #15939

wants to merge 2 commits into from

Conversation

cmb69
Copy link
Member

@cmb69 cmb69 commented Sep 17, 2024

This was so far hosted on qa.php.net, but since there are plans to retire that site, we move the relevant documentation about PHPTs to php-src/docs.


Note that these are only a first few sections of https://qa.php.net/phpt_details.php, so the format can be determined/discussed before porting the whole documentation (including https://qa.php.net/write-test.php).

cc @derickr

This was so far hosted on qa.php.net, but since there are plans to
retire that site, we move the relevant documentation about PHPTs to
php-src/docs.
@iluuu1994
Copy link
Member

Unfortunately, rstfmt doesn't support custom directives 😞 There were multiple reports about it but I didn't find a workaround. If we require them at some point, I don't object to dropping the tool. It's more important to have good documentation than nicely formatted one.

@cmb69
Copy link
Member Author

cmb69 commented Sep 17, 2024

Unfortunately, rstfmt doesn't support custom directives

No problem; I've already updated the PR. It might be a good idea to add the rstfmt check to make.bat, and maybe to also provide a make.sh doing the same.

I'm going to also provide a PR for an MD alternative; then we can see what we like better.

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

Successfully merging this pull request may close these issues.

2 participants