Include Docstrings for ssg/build_yaml.py #12609
Merged
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
8 classes and 140 functions were reviewed and docstrings were provided. No code was changed, but some comments were removed since they were incorporated in docstrings text. Also some onei-line functions which are self-explained were skipped of including docstrings. Signed-off-by: Marcus Burghardt <[email protected]>
marcusburghardt
changed the title
|
Start a new ephemeral environment with changes proposed in this pull request: Fedora Environment Oracle Linux 8 Environment |
|
This PR is also related to #12606, which is part of the same initiative. |
Removed until we find a consensus regarding including or not methods information in classes Docstrings. Signed-off-by: Marcus Burghardt <[email protected]>
Mab879
requested changes
Nov 20, 2024
Co-authored-by: Matthew Burket <[email protected]>
Co-authored-by: Matthew Burket <[email protected]>
Co-authored-by: Matthew Burket <[email protected]>
Co-authored-by: Matthew Burket <[email protected]>
Co-authored-by: Matthew Burket <[email protected]>
Signed-off-by: Marcus Burghardt <[email protected]>
|
Code Climate has analyzed commit 5c0ecd5 and detected 28 issues on this pull request. Here's the issue category breakdown:
The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 60.9% (0.0% change). View more on Code Climate. |
|
/packit build |
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.
Description:
8classes and140functions were reviewed and Docstrings were provided.No code was changed, but some comments were removed since they were incorporated in Docstrings text.
Also some one-line functions which are self-explained were skipped of including Docstrings.
Rationale:
Once the PR is merged, the Docstrings should also improve our documentation in https://complianceascode.readthedocs.io/en/latest/modules/ssg.html, making it easier for the community to consume and contribute to the ssg library.
Review Hints:
No code was changed, so no risk is expected from this PR. In some isolated cases I removed comments from functions because they were incorporated in Docstrings, so duplication was not necessary. But in general ensured no code changes.