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

PHP 7.4: PCRE: document new $flags param for preg_replace_callback[_array]() #89

Closed

Conversation

jrfnl
Copy link
Contributor

@jrfnl jrfnl commented May 12, 2020

The PHP 7.4 $flags parameter as added to the preg_replace_callback() and preg_replace_callback_array() functions was not yet included in the documentation.

In this PR, I'm

  • Adding the parameter to the function signature.
  • Adding minimal parameter documentation with a reference to the more detailed explanation in the parameter documentation of the preg_match() function.
  • Adding a changelog entry for the parameter to each function.

🤞 I hope I've got the xml syntax right for this change. I'm not 100% familiar yet with it, so please bear with me if I've got it wrong. (and just tell me what I've got wrong & I'll fix it promptly)

Refs:

…rray]()

The PHP 7.4 `$flags` parameter as added to the `preg_replace_callback()` and `preg_replace_callback_array()` function was not yet included in the documentation.

In this PR, I'm
* Adding the parameter to the function signature.
* Adding minimal parameter documentation with a reference to the more detailed explanation in the parameter documentation of the [`preg_match()`](https://www.php.net/manual/en/function.preg-match.php) function.
* Adding a changelog entry for the parameter to each function.

Refs:
* php/php-src#3958
* https://github.com/php/php-src/blob/2f1398dad934086b605073c51af3118c8eff28b1/UPGRADING#L304-L308
@jrfnl jrfnl force-pushed the feature/pcre-preg_replace_callback-flags-param branch 2 times, most recently from 4f85e79 to cd8ca75 Compare May 12, 2020 14:09
@jrfnl
Copy link
Contributor Author

jrfnl commented May 23, 2020

Anything I need to update for this PR to be considered ?

@cmb69
Copy link
Contributor

cmb69 commented May 23, 2020

Thanks for the ping! The patch is good, but there is no need to explicitly link functions; just marking them up as <function>func_name</function> is sufficient (links are then inserted automatically if the function is documented).

I've applied that as http://svn.php.net/viewvc?view=revision&revision=349965.

PS: and thanks for the PR! :)

@cmb69 cmb69 closed this May 23, 2020
@jrfnl
Copy link
Contributor Author

jrfnl commented May 23, 2020

there is no need to explicitly link functions; just marking them up as func_name is sufficient

Thanks, this was one of the first PRs I send in. I'm slowly learning how it all works and hopefully getting better at it ;-)

@jrfnl jrfnl deleted the feature/pcre-preg_replace_callback-flags-param branch May 23, 2020 16:31
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.

None yet

2 participants