search

ComplianceAsCode / content

Security automation content in SCAP, Bash, Ansible, and other formats
https://complianceascode.readthedocs.io/en/latest/
Other
2.22k stars 698 forks source link

Include Docstrings for ssg/build_yaml.py #12609

Open marcusburghardt opened 1 week ago

marcusburghardt commented 1 week ago

Description:

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 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.

github-actions[bot] commented 1 week ago

Start a new ephemeral environment with changes proposed in this pull request:

Fedora Environment Open in Gitpod

Oracle Linux 8 Environment Open in Gitpod

marcusburghardt commented 1 week ago

This PR is also related to #12606, which is part of the same initiative.

codeclimate[bot] commented 16 hours ago

Code Climate has analyzed commit 5c0ecd5d and detected 28 issues on this pull request.

Here's the issue category breakdown:

Category Count
Style 28

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.