Skip to content

Fix markdown query help formatting #19892

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

owen-mc
Copy link
Contributor

@owen-mc owen-mc commented Jun 26, 2025

Follow-up to #19730.

@Copilot Copilot AI review requested due to automatic review settings June 26, 2025 14:25
@owen-mc owen-mc requested review from a team as code owners June 26, 2025 14:25
@github-actions github-actions bot added documentation Java Ruby Actions Analysis of GitHub Actions labels Jun 26, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

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
File Description
ruby/ql/src/queries/variables/UninitializedLocal.md Updated header titles and removed an extra context header.
java/ql/src/Violations of Best Practice/Undesirable Calls/DoNotCallFinalize.md Reformatted headings and reference bullets.
java/ql/src/Performance/StringReplaceAllWithNonRegex.md Changed heading to “## Overview” for clarity.
docs/query-help-style-guide.md Enforced full-stop punctuation in reference items.
actions/ql/** Applied consistent markdown heading changes and reference formatting updates across all action-related query files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Actions Analysis of GitHub Actions documentation Java Ruby
2 participants