SQL comments to index positional arguments

[seancolsen]

This PR is a small non-functional change to serve as a sort of async discussion thread.

@mathemancer and @Anish9901, what would your appetite be for allowing some manually-maintained comments in our SQL codebase like this? I recognize that they're more work to maintain. But, being that code gets read more than written, I would find comments like this quite helpful. Personally, I don't think I've ever worked with such poorly readable code in my whole career. Like, I cannot believe I need to manually count over a dozen expressions just to read something. This is not to blame anyone who wrote this particular code, but rather just a general frustration with the limited expressiveness of PL/pgSQL.

With the comments there, I can highlight a positional index and then see all the places it occurs like this:

But if you don't like the idea of these comment indexes, then I won't make a stink about it, and we can close this PR. Or, if you like this idea, then we can merge this and add them as needed.

I'm not proposing that we use them everywhere. And I'm not proposing that we do any additional work to go add them all over the place right now. I'd just like to be able to add them to code blocks like this which are particularly unwieldy.

I have a VS Code extension called vscode-input-sequence which makes adding and updating sequences like this pretty easy. Perhaps theres Emacs as something like this too.

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the develop branch of the repository
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.