fix(docstrings): add blank line before example #5033
Merged
Conversation
This file contains hidden or 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
terriko
requested changes
Apr 21, 2025
There was a problem hiding this comment.
Looks like you've got a couple of flake8 errors:
cve_bin_tool/cve_scanner.py:67:1: W293 blank line contains whitespace
cve_bin_tool/helper_script.py:218:17: W291 trailing whitespace
Running black on those two files will likely fix it, but I've also manually added fixes that you can probably just accept if you don't have black set up.
More on our linters and how to set them up here if you need it: https://github.com/intel/cve-bin-tool/blob/main/CONTRIBUTING.md#running-linters
|
I've run |
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.
🛠️ What This Fix Does
Previously, it did not render some docstrings correctly. This was due to missing blank lines between the summary and the
Example:section, causingExample:blocks to not display properly in the generated documentation.This fix adds the required blank line after the summary in affected docstrings, ensuring it renders the examples correctly.
This improves documentation readability and ensures consistency across the project.
📌 Related Issue
Fixes #5032