📝 Improves Documentation of Alpine Methods

[ekwoka]

Please fill in this template.

• Use a meaningful title for the pull request. Include the name of the package modified.
• Test the change in your own code. (Compile and run.)
• Add or edit tests to reflect the change.
• Follow the advice from the readme.
• Avoid common mistakes.
• Run npm test <package to test>.

If changing an existing definition:

• Provide a URL to documentation or source code which provides context for the suggested changes: <>
• If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

[typescript-bot]

@ekwoka Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in this PR

• alpinejs — on npm, on unpkg (author is owner)

Code Reviews

This PR can be merged once it's reviewed by a DT maintainer.

You can test the changes of this PR in the Playground.

Status

• ✅ No merge conflicts
• ✅ Continuous integration tests have passed
• ✅ Only a DT maintainer can approve changes without tests

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

Inactive

This PR has been inactive for 31 days — closed because it wasn't merged for a long time!

---

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 66890,
  "author": "ekwoka",
  "headCommitOid": "4bc403cad223d7eb9f6f7d698f0d12fa7d04043c",
  "mergeBaseOid": "62e861498b0c5a98468c18624877a046ec9ae0b8",
  "lastPushDate": "2023-10-01T16:38:56.000Z",
  "lastActivityDate": "2023-10-02T19:45:41.000Z",
  "mergeOfferDate": "2023-10-02T19:46:24.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "alpinejs",
      "kind": "edit",
      "files": [
        {
          "path": "types/alpinejs/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "wtho",
        "ekwoka"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "rbuckton",
      "date": "2023-10-02T19:45:41.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "Semigradsky",
      "date": "2023-10-01T19:04:32.000Z",
      "abbrOid": "7bad3a3"
    }
  ],
  "mainBotCommentID": 1742134110,
  "ciResult": "pass"
}

[typescript-bot]

Hey @ekwoka,

😒 Your PR doesn't modify any tests, so it's hard to know what's being fixed, and your changes might regress in the future. Please consider adding tests to cover the change you're making. Including tests allows this PR to be merged by yourself and the owners of this module.

This can potentially save days of time for you!

[typescript-bot]

🔔 @wtho — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

[typescript-bot]

@ekwoka The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

[typescript-bot]

@ekwoka The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

[Semigradsky]

I don't know why I see this PR in my notifications but LGTM!

[dygy]

I don't know why I see this PR in my notifications but LGTM!

same shit bro :DDDD

[ekwoka]

😆

I guess just from having recent commits somehow the bot/github messed up

Oh no, I realized I had accidentally made the pr with gh pr create -f and it somehow filled in info from the last 30 commits on main as the PR description before I edited it...

so people got tagged....

well, at least i didn't tag epic games

[typescript-bot]

@Semigradsky Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

[typescript-bot]

@ekwoka: Everything looks good here. I am ready to merge this PR (at 4bc403c) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@wtho: you can do this too.)

[typescript-bot]

Re-ping @ekwoka / @wtho:

This PR has been ready to merge for over a week, and I haven't seen any requests to merge it. I will close it on Nov 1st (in three weeks) if this doesn't happen.

(If there's no reason to avoid merging it, please do so. Otherwise, if it shouldn't be merged or if it needs more time, please close it or turn it into a draft.)

[typescript-bot]

After a month, no one has requested merging the PR 😞. I'm going to assume that the change is not wanted after all, and will therefore close it.