Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update(docs): results documentation update #6885

Merged
merged 7 commits into from
Feb 23, 2024
Merged

update(docs): results documentation update #6885

merged 7 commits into from
Feb 23, 2024

Conversation

ArturRibeiro-CX
Copy link
Contributor

@ArturRibeiro-CX ArturRibeiro-CX commented Feb 15, 2024 •
edited
Loading

Proposed Changes

  • updated documentation to include uniform examples of a single query across all available report formats, enabling users to compare and contrast the differences in presentation and structure between each format effectively.
  • added key-value pairs explanation for better understanding of each report format.

I submit this contribution under the Apache-2.0 license.

@github-actions github-actions bot added the query New query feature label Feb 15, 2024
@github-actions GitHub Actions
Copy link
Contributor

kics-logo

KICS version: v1.7.12

Category Results
HIGH HIGH 0
MEDIUM MEDIUM 0
LOW LOW 0
INFO INFO 0
TRACE TRACE 0
TOTAL TOTAL 0
Metric Values
Files scanned placeholder 1
Files parsed placeholder 1
Files failed to scan placeholder 0
Total executed queries placeholder 49
Queries failed to execute placeholder 0
Execution time placeholder 1

@ArturRibeiro-CX ArturRibeiro-CX added documentation Improvements or additions to documentation and removed query New query feature labels Feb 15, 2024
@github-actions github-actions bot added query New query feature and removed documentation Improvements or additions to documentation labels Feb 15, 2024
@ArturRibeiro-CX ArturRibeiro-CX changed the title results documentation update update(docs): results documentation update Feb 15, 2024
@ArturRibeiro-CX ArturRibeiro-CX added documentation Improvements or additions to documentation and removed query New query feature labels Feb 16, 2024
@github-actions github-actions bot added query New query feature and removed documentation Improvements or additions to documentation labels Feb 16, 2024
@gabriel-cx gabriel-cx merged commit 4759c50 into master Feb 23, 2024
20 checks passed
@gabriel-cx gabriel-cx deleted the documentation_update branch February 23, 2024 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gabriel-cx gabriel-cx gabriel-cx approved these changes

Assignees
No one assigned
Labels
query New query feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ArturRibeiro-CX @gabriel-cx