Skip to content

Clarify sentence about "last_affected" and "fixed" in docs. #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tiegz
Copy link

@tiegz tiegz commented Nov 7, 2024

From the docs:

Entries in the events array can contain either "last_affected" or "fixed" events, but not both.

This line could be referring to either of these events arrays:

{
  "events": [
    {"introduced": "0.0.0"},
    {"last_affected": "1.0.0", "fixed": "1.0.1"}
  ]
}
{
  "events": [
    {"introduced": "0.0.0"},
    {"last_affected": "1.0.0"},
    {"fixed": "1.0.1"}
  ]
}

The first one is invalid because it has an Object that contains two entries, but that is covered by this line from the docs:

Only a single type (either introduced, fixed, last_affected, limit) is allowed in each event object.

And according to this comment I think the latter invalid case is the one that is being referred to: #146 (comment)

So I suggest changing the wording to be more specific:

An events array can have entries containing either "last_affected" or "fixed" events, but not both.

Co-authored-by: Andrew Pollock <[email protected]>
Signed-off-by: Tieg Zaharia <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants