- 🇳🇿New Zealand quietone
This is still valid and is suitable for a first issue.
- 🇩🇪Germany ro-no-lo
With the latest PHP 8.x I think we could avoid many of these phpDocs by just using the types inside the method signature.
- First commit to issue fork.
- 🇺🇸United States jcorrao
jcorrao → changed the visibility of the branch 1965508-improve-doc-block to hidden.
- Merge request !7990Issue #1965508: Improve documentation for Unicode::truncate() → (Open) created by jcorrao
- Status changed to Needs review
about 1 year ago 10:45pm 8 May 2024 - 🇺🇸United States jcorrao
I have gone through and reviewed the patch file from #1 and ported the changes to the relevant counterpart in the 11.x codebase.
The type declarations in the PHPDoc patch were present in 11.x already, however they were missing the `(optional)` declaration as described in the linked PHP Documentation Standards page: http://drupal.org/node/1354
MR !7990 is published and ready for review.
- 🇺🇸United States smustgrave
So re-ran the tests but getting many failures and not sure why with just comments.
- Status changed to Needs work
about 1 year ago 12:27pm 10 May 2024 - 🇺🇸United States smustgrave
Believe the issue has been fixed but just needs a rebase.
- 🇧🇷Brazil isa.bel Balneário Camboriú
isa.bel → made their first commit to this issue’s fork.
- Merge request !11746Issue #1965508: Improve documentation for Unicode::truncate() → (Closed) created by isa.bel
- 🇧🇷Brazil isa.bel Balneário Camboriú
I rebased the current branch using the latest version of core. Ready to be reviewed
- 🇺🇸United States xjm
Added
(optional)
and the wrapping look correct. The only thing is that we have a pattern of describing the default behavior of optional parameters, e.g. "Defaults to FALSE." This is useful when the PHPDoc is being read outside the context of the codebase. Can we add that to these three parameters?Thanks!
Saving credits.
- First commit to issue fork.
- 🇬🇧United Kingdom nexusnovaz
I've added some descriptions, i think this is good for review.
Thanks.
- 🇺🇸United States xjm
I think those look great, thanks @nexusnovaz!