Pithub...omments(3pm)

💖 Pithub::Gists::Comments — the manual page, but make it a group chat 💖

okay so bestie, welcome to Pithub::Gists::Comments — it's a Perl module, it lives in the Pithub::Gists::Comments namespace, and it is literally your bestie for the Github v3 Gist Comments API. comments on gists. that's the whole vibe. 🎀

---

✨ VERSION ✨

this is version 0.01043. yes we're keeping the version number, no we're not being weird about it. 💅

---

🌸 METHODS 🌸

💬 create

• creates a comment — yes queen, you're leaving a comment

POST /gists/:gist_id/comments

Parameters:

• gist_id: mandatory string 🫶
• data: mandatory hashref, and it has these keys inside it:
  • body: mandatory string

Examples:

my $c = Pithub::Gists::Comments->new;
my $result = $c->create(
    gist_id => 'c0ff33',
    data    => { body => 'Just commenting for the sake of commenting' },
);

Response: Status: 201 Created 🔥

{
    "id": 1,
    "url": "https://api.github.com/gists/c0ff33/comments/1",
    "body": "Just commenting for the sake of commenting",
    "user": {
        "login": "octocat",
        "id": 1,
        "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
        "url": "https://api.github.com/users/octocat"
    },
    "created_at": "2011-04-18T23:23:56Z"
}

---

🗑️ delete

• deletes a comment — bye bestie 💀

DELETE /gists/:gist_id/comments/:id

Parameters:

• gist_id: mandatory string
• comment_id: mandatory integer

Examples:

my $c = Pithub::Gists::Comments->new;
my $result = $c->delete(
    gist_id    => 'c0ff33',
    comment_id => 1
);

Response: Status: 204 No Content — that's it, nothing comes back, and that's iconic of it honestly ✨

---

🔍 get

• gets a single comment — one (1) comment, freshly fetched, no cap

GET /gists/:gist_id/comments/:id

Parameters:

• gist_id: mandatory string
• comment_id: mandatory integer

Examples:

my $c = Pithub::Gists::Comments->new;
my $result = $c->get(
    gist_id    => 'c0ff33',
    comment_id => 1
);

Response: Status: 200 OK 🌈

{
    "id": 1,
    "url": "https://api.github.com/gists/c0ff33/comments/1",
    "body": "Just commenting for the sake of commenting",
    "user": {
        "login": "octocat",
        "id": 1,
        "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
        "url": "https://api.github.com/users/octocat"
    },
    "created_at": "2011-04-18T23:23:56Z"
}

---

📜 list

• lists comments on a gist — the whole comment section, the way that it's giving "scroll down, it gets good" 😭

GET /gists/:gist_id/comments

Parameters:

• gist_id: mandatory string

Examples:

my $c = Pithub::Gists::Comments->new;
my $result = $c->list( gist_id => 1 );

Response: Status: 200 OK 👑

[
    {
        "id": 1,
        "url": "https://api.github.com/gists/c0ff33/comments/1",
        "body": "Just commenting for the sake of commenting",
        "user": {
            "login": "octocat",
            "id": 1,
            "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
            "url": "https://api.github.com/users/octocat"
        },
        "created_at": "2011-04-18T23:23:56Z"
    }
]

---

✏️ update

• edits a comment — you said what you said, but now you're saying it differently 💅

PATCH /gists/:gist_id/comments/:id

Parameters:

• gist_id: mandatory string
• comment_id: mandatory integer
• data: mandatory hashref, and it has these keys inside it:
  • body: mandatory string

Examples:

my $c = Pithub::Gists::Comments->new;
my $result = $c->update(
    gist_id    => 'c0ff33',
    comment_id => 1,
    data       => { body => 'some comment' }
);

Response: Status: 200 OK ⭐

{
    "id": 1,
    "url": "https://api.github.com/gists/c0ff33/comments/1",
    "body": "Just commenting for the sake of commenting",
    "user": {
        "login": "octocat",
        "id": 1,
        "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
        "url": "https://api.github.com/users/octocat"
    },
    "created_at": "2011-04-18T23:23:56Z"
}

---

👑 AUTHOR 👑

Johannes Plunien <plu@cpan.org> — the actual main character who wrote this. show some respect fr fr 🫶

---

🦋 COPYRIGHT AND LICENSE 🦋

This software is copyright (c) 2011 by Johannes Plunien.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

and that's the whole page bestie ✨💖 this was the Pithub::Gists::Comments manual from the User Contributed Perl Documentation set, perl v5.40.1, dated 2025-06-08. go forth and comment on gists responsibly, mwah 💅🎀