Skip to content

Conversation

@ConnorKirk
Copy link
Contributor

@ConnorKirk ConnorKirk commented Nov 5, 2025

Issue number: closes #7637

Summary

Changes

Fixed incorrect line highlighting in the batch processing error handling documentation. Changed hl_lines="24" to hl_lines="23" in docs/utilities/batch.md to correctly highlight the line where the raise InvalidPayload exception is raised instead of highlighting an empty line.

User experience

Before: Documentation highlighted line 24, which is an empty line, making it unclear which code demonstrates the error handling behavior.

After: Documentation now correctly highlights line 23, where the raise InvalidPayload("Payload does not contain minimum information to be processed.") statement occurs, clearly showing the error handling example.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Fixed the highlighted line in the batch processing error handling example
from line 24 (empty line) to line 23 (the actual raise statement). This
ensures the documentation correctly highlights where the InvalidPayload
exception is raised in the error handling example.
@ConnorKirk ConnorKirk requested a review from a team as a code owner November 5, 2025 12:25
@ConnorKirk ConnorKirk requested a review from hjgraca November 5, 2025 12:25
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Nov 5, 2025
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 5, 2025
@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 5, 2025

@leandrodamascena leandrodamascena merged commit ee7f9ce into develop Nov 5, 2025
15 checks passed
@leandrodamascena leandrodamascena deleted the docs/fix-batch-error-handling-highlight branch November 5, 2025 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Fix incorrect line highlight in batch error handling example

3 participants