doc-en icon indicating copy to clipboard operation
doc-en copied to clipboard

Update Imagick method synopses (#4118)

Open stefanfisk opened this issue 1 year ago • 3 comments

The argument names were wrong for a lot of methods.

I'm not entirely sure that I know what I'm doing, but the steps I took were:

  1. Clone php/doc-en, php/doc-base, php/php-src and Imagick/imagick
  2. Manually fix the stub signature for Imagick::newImage() like in https://github.com/Imagick/imagick/pull/674
  3. ./php-src/build/gen_stub.php --replace-methodsynopses ./imagick/*.stub.php ./doc-en/reference/imagick/

Resolves #4118.

stefanfisk avatar Nov 21 '24 14:11 stefanfisk

I also had to do some manual cleanup of trailing white space.

stefanfisk avatar Nov 22 '24 09:11 stefanfisk

Could you maybe do this class by class in different PRs? As the stub changes currently also impacts how Xincludes are down in the class synopsis, so you probably need to also run ./php-src/build/gen_stub.php --replace-classsynopses ./imagick/*.stub.php ./doc-en/reference/imagick/ :)

Girgias avatar Nov 22 '24 20:11 Girgias

@Girgias I'm afraid that's more time than I have available to spend on this :(

I totally understand if you don't want to merge this massive PR. You can just close it if it's too much to handle.

stefanfisk avatar Jan 01 '25 14:01 stefanfisk