- Issue created by @drunken monkey
- First commit to issue fork.
- Merge request !259Issue #3539930 by neerajsingh, drunken monkey: Update the data types we use in doc comments → (Merged) created by neerajsingh
- 🇮🇳India neerajsingh IN 🇮🇳
Created a MR with, updates to doc comments for array. This needs to be reviewed for any further data type updates.
- 🇦🇹Austria drunken monkey Vienna, Austria
Thanks, that’s a great start!
However, just looking atIndex
andIndexInterface
I saw a bunch of more places where types were too unspecific (and even found a bug, 🐛 Fix Index::setProcessors() to not assume $processors is keyed by plugin ID Active , though that‘s beside the point). Not really sure how we can get close to a complete MR for this. Seems like a ton of work, and very hard to review and validate. But just doing this piecemeal is also a bit unsatisfactory (and hard to lose track).Suggestions are welcome.
- 🇦🇹Austria drunken monkey Vienna, Austria
Cleaned up the rest of
Index
andIndexInterface
and then just merged this as a first step.Judging by
git grep -lE '@(param|var|return) (array( |$)|.*\[\])'
, there are now still 178 files with … 623 (potentially) suboptimal type hints left. I think form or render arrays can probably keep the simplearray
type hint, but probably there’s no other place where we cannot improve this (orTYPE[]
) toarray<KEY_TYPE, TYPE>
orlist<TYPE>
.So, maybe child issues for separate batches of these files, or maybe based on parent directory? What would be a good batch size?
I don’t want to divide this too finely and just create a huge flood of contrib credits, but it is tedious work and I don’t think anyone is willing to create or review a single MR for 50 files of this. Now that this issue is closed, please review the contribution record.
As a contributor, attribute any organization helped you, or if you volunteered your own time.
Maintainers, please credit people who helped resolve this issue.
-
drunken monkey →
committed 8f41a792 on 8.x-1.x authored by
neerajsingh →
[#3539930] chore: Improved the specificity of type hints given in doc...
-
drunken monkey →
committed 8f41a792 on 8.x-1.x authored by
neerajsingh →