This repository was archived by the owner on Jan 2, 2025. It is now read-only.
Fix LLM responses which include an inline [^summary]
#816
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Depends on #811.
Some LLM articles contain a final paragraph like so:
In this instance, the LLM has accidentally attached the summary to the end of the final markdown paragraph, instead of putting the summary (which is a markdown footnote definition) into its own block. To correct for this, we utilize
comrakto examine all top-levelParagraphnodes, and extract a summary, if one is found in plain text.Note: This implementation will work for cases where a code snippet contains
[^summary]: ..., and it will also work when there is inline code, such as article that writes:Summaries are created by attaching `[^summary]:` to. These complex test cases are accounted for with the addition of a new unit test.Closes BLO-1369