Guidance for adding bullet points in personalisation

alphagov / notifications-php-client

PHP client for the GOV.UK Notify API

https://docs.notifications.service.gov.uk/php.html

MIT License

11 stars 13 forks source link

Guidance for adding bullet points in personalisation #131

Closed CrystalPea closed 10 months ago

CrystalPea commented 10 months ago

What problem does the pull request solve?

Checklist

[x] I’ve used the pull request template
[ ] I’ve written unit tests for these changes
[ ] I’ve updated the documentation (in DOCUMENTATION.md and CHANGELOG.md)
[ ] I’ve bumped the version number (const VERSION in src/Client.php)

CrystalPea commented 10 months ago

@idavidmcdonald thanks a lot!

The example I used is both an array and a list I think: https://www.php.net/manual/en/function.array-is-list.php

In detail, I think it is an indexed array without key:

https://www.php.net/manual/en/language.types.array.php (Example #4 Indexed arrays without key)

Might be worth trying this out locally if you haven't already? Just to make sure it does work as intended

Are we supposed to do this for all tech docs? 😳 I have never ran PHP before, but I could try?

idavidmcdonald commented 10 months ago

Only for tech doc changes that you want to get more confidence are correct... if you are confident enough already that the above will work in the PHP client, then no need to extra testing... if you aren't, then could be worth trying locally.

If so, you may find it easiest to use the php docker image to install the client in and then write a simple script. Up to you though. I'll let you judge if it is needed or worth it.

CrystalPea commented 10 months ago

I checked and those code snippets work, so I will deploy this change.