scripts: backstage: Warn on missing description #1553
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If a doc page does not contain an overview/short-description, exit with an error. Fix IndexError at get_description. Signed-off-by: Jorge Marques <[email protected]>
gastmaier
requested review from
acostina,
AndreiGrozav,
PopPaul2021 and
sarpadi
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Description
Based on this ci run: https://github.com/analogdevicesinc/hdl/actions/runs/12636173279/job/35207649065
It is required that all libraries and projects contain an overview/short-description at the beginning of the file.
Exit with a message error when it is missing and fix the IndexError.
PR Type
PR Checklist