Skip to content
Back to top
View this page

# CommentChangeNote

class chango.concrete.CommentChangeNote(slug, comment, uid=None)

  Bases: `ChangeNote`

  A simple change note that consists of a single comment. May be multi-line.

  Parameters:

    comment (`str`) – The comment text.

  comment

    The comment text.

    Type:

      `str`

  MARKUP = 'txt'

    The markup language used in the comment. Will also be used as file extension.

    Type:

      `str`

  classmethod build_from_github_event(event, data=None)

    Implementation of `build_from_github_event()`.

    Considers only events of type `pull_request` and `pull_request_target`. Uses the pull request number as slug and the pull request title as comment.

    Currently only supports `TEXT`,

      `MARKDOWN`, `RESTRUCTUREDTEXT` and `HTML`.

    Caution

    Does not consider any formatting in the pull request title!

    Raises:

      ValueError – If required data is missing or not in the expected format or if `MARKUP` is not supported.