Skip to content

clarify and reject invalid columns for annotations #340

Description

@jtnord

The values for coulmn start / end values do not state if columns are zero or 1 based.

GitHub (by far the most popular) uses 1 based indexing, as does cursor origin.

The documentation should be clear for implementators so they know what maths (if any) they need to perform on these values.

Additionally, invalid values are allowed without warning - if one based which is what GitHub checks assumes, which can cause failure to publish these checks as zero is less than 1.

The code should clarify that these are 1 based. Additionally the code should prevent invalid values from being added in the builder (like it does for null values).

see jenkinsci/warnings-ng-plugin#3424 / jenkinsci/cursor-origin-branch-source-plugin#12 (comment) for an real world issue caused by this

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions