ViolationNote

class understand.ViolationNote

Bases: object

CodeCheck plugin violation note object

Violation notes are returned from CheckViolation.add_note. Use the note object to add highlights.

Methods Summary

add_highlight

Add a highlight associated with this violation note.

Methods Documentation

add_highlight(line, column, end_line, end_column) → None

Add a highlight associated with this violation note.

Parameters:

  • line (int) – the first line in the range of text

  • column (int) – the first column in the range of text

  • end_line (int) – the last line in the range of text

  • end_column (int) – the last column in the range of text

Return type:

None