Skip to content

Fix markdown query help formatting - #19892

Merged
owen-mc merged 5 commits into
github:mainfrom
owen-mc:fix-markdown-query-help-formatting
Jul 1, 2025
Merged

Fix markdown query help formatting#19892
owen-mc merged 5 commits into
github:mainfrom
owen-mc:fix-markdown-query-help-formatting

Conversation

@owen-mc

Copy link
Copy Markdown
Contributor

Follow-up to #19730.

CopilotAI review requested due to automatic review settings June 26, 2025 14:25
@owen-mc
owen-mc requested review from a team as code ownersJune 26, 2025 14:25

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR standardizes and streamlines markdown query help formatting across multiple files. Key changes include renaming section headings (e.g. “Description” → “Overview”, “Recommendations” → “Recommendation”, “Examples” → “Example”) and updating reference list formatting to enforce a trailing full stop.

Reviewed Changes

Copilot reviewed 33 out of 33 changed files in this pull request and generated no comments.

Show a summary per file
FileDescription
ruby/ql/src/queries/variables/UninitializedLocal.mdUpdated header titles and removed an extra context header.
java/ql/src/Violations of Best Practice/Undesirable Calls/DoNotCallFinalize.mdReformatted headings and reference bullets.
java/ql/src/Performance/StringReplaceAllWithNonRegex.mdChanged heading to “## Overview” for clarity.
docs/query-help-style-guide.mdEnforced full-stop punctuation in reference items.
actions/ql/**Applied consistent markdown heading changes and reference formatting updates across all action-related query files.

@owen-mc
owen-mc merged commit 811ed3c into github:mainJul 1, 2025
@owen-mc
owen-mc deleted the fix-markdown-query-help-formatting branch July 1, 2025 11:05
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ActionsAnalysis of GitHub ActionsdocumentationJavaRuby

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@owen-mc@adityasharad