'comment-id' can be confusing between actual comment.id and issuecomment number

[abower-digimarc]

When viewing github pr comment json, each comment has an id attribute. I initially fetched and provided this ID to the action, and it failed to update a comment, instead writing a new one.

Reviewing the docs and the msg output of the action, I realized that the numerical 'comment-id' being used is actually a component of the comment url.

It might be helpful to either update the nomenclature to make sure users know the 'id' being used is from the url, and not the actual id. Alternately, a blurb in the comment-id description which warns that it isn't the github comment id could help future users.

[peter-evans]

Hi @abower-digimarc

Do you have an example of where the confusion is in the JSON? Maybe it's the GraphQL ID that you tried. 🤔

comment-id is the correct terminology. This is what is used in the API documentation.