Skip to content

Improved error checking when parsing a Blurb. #507

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

Merged

Conversation

larryhastings
Copy link
Contributor

We now:

  • Check the entries in metadata in order, so we complain about the first one that has an error, which is a more familiar user experience.
  • Have checks for:
    • Invalid issue number
    • Invalid section
    • Empty section
    • Completely missing section

(There is no test for "missing issue number", because it's legal to have a Blurb with no issue number. "no changes" blurbs don't have an issue number. But we do now reliably test that, if the issue number is specified, it is correctly formatted.)

We now:
* Check the entries in metadata in order, so we complain about
  the *first* one that has an error, which is a more familiar
  user experience.
* Have checks for:
	* Invalid issue number
	* Invalid section
	* Empty section
	* Completely missing section

(There is no test for "missing issue number", because it's legal
to have a Blurb with no issue number.  "no changes" blurbs don't
have an issue number.  But we do now reliably test that, *if* the
issue number is specified, it *is* correctly formatted.)
@larryhastings larryhastings requested a review from hugovk July 23, 2023 13:34
@larryhastings larryhastings merged commit a0db0d9 into python:main Jul 23, 2023
@larryhastings larryhastings deleted the improve_blurb_parse_error_detection branch July 23, 2023 13:36
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