Skip to content

docs: ajouter des exemples concrets dans les PHPDoc des shortcodes#989

Merged
CySSoO merged 1 commit intomasterfrom
cyssoo/add-php-documentation-for-shortcodes
Mar 4, 2026
Merged

docs: ajouter des exemples concrets dans les PHPDoc des shortcodes#989
CySSoO merged 1 commit intomasterfrom
cyssoo/add-php-documentation-for-shortcodes

Conversation

@CySSoO
Copy link
Contributor

@CySSoO CySSoO commented Mar 4, 2026

Motivation

  • Faciliter la compréhension et l'utilisation des shortcodes en fournissant des exemples concrets d'appel pour chaque gestionnaire de shortcode et utilitaire lié au moteur de shortcodes.
  • Améliorer la maintenabilité et l'onboarding des développeurs en rendant les usages attendus explicites dans la documentation PHP des méthodes.

Description

  • Ajout de blocs @example dans les PHPDoc de l'entrée du moteur renderShortcodes et des utilitaires parseShortcodeAttrs et resolveShortcodeArgs dans src/Service/EverblockTools.php.
  • Ajout d'un bloc @example pour chaque méthode gérant un shortcode (ex: getProductsByTagShortcode, getEverBlockShortcode, getBestSalesShortcode, getEverMapShortcode, etc.) dans src/Service/EverblockTools.php afin de montrer un appel concret du shortcode correspondant.
  • Uniformisation des exemples pour qu'ils soient exploitables directement (format de shortcode, paramètres courants) et amélioration de la lisibilité des PHPDoc autour du moteur de shortcodes.

Testing

  • J'ai exécuté la vérification de syntaxe PHP avec php -l src/Service/EverblockTools.php et la commande a indiqué No syntax errors detected, confirmant que les modifications n'introduisent pas d'erreurs de syntaxe.

Codex Task

@CySSoO CySSoO merged commit 8dfa3ef into master Mar 4, 2026
2 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant