Fábio Beirão (May 26 2023 at 08:33): Fábio Beirão (May 26 2023 at 08:33):While going through the documentation I notice that there seem to be two styles of "present tense" (sorry if this is the incorrect concept). Examples of what I mean:
Dict.empty: Return an empty ...
Dict.capacity: Returns the max ...
Dict.withCapacity: Return a dictionary ...
Dict.single: Returns a dictionary ...
I would like to make a PR to (if possible) increase the consistency for the reader, who like me is reading from top to bottom to get a sense of what exists. Or maybe this isn't a problem at all :sweat_smile: Let me know your thoughts :smile:
Anton (May 26 2023 at 09:23):Feel free to go ahead with a PR :)
I suggest we use "Returns" everywhere
Fábio Beirão (May 26 2023 at 12:10):Hello Anton. The PR is getting a bit large, which reduces the chance of a successful and productive merge. I haven't yet reviewed all the documentation, but for now this is the PR. Let me know if this is going in the desired direction.
Anton (May 26 2023 at 13:07):Thanks @Fábio Beirão, smaller PRs are indeed nicer :)
I'll take a look in a bit.
Anton (May 26 2023 at 13:17):Let me know if this is going in the desired direction.
Looks good @Fábio Beirão, should I already merge it?
Fábio Beirão (May 26 2023 at 13:26):Yes it can already be merged and I'll carry on later today :)
Last updated: Jul 06 2025 at 12:14 UTC