Update qhelp style guide for markdown format #19730
Open
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Query Help Style Guide to document support for Markdown-formatted query help files alongside the existing XML format.
- Introduces a new section detailing the structure and requirements for Markdown
.mdquery help files. - Harmonizes references to section-level elements across both Markdown and XML formats.
- Adds a combined Markdown and XML query help example for Java.
Comments suppressed due to low confidence (2)
docs/query-help-style-guide.md:77
- The term “description section” is ambiguous in the Markdown context (we only define Overview, Recommendation, Example, etc.). Consider replacing “description section” with “overview section” or clarifying when each section should contain examples.
* Put the code example after the recommendation section where possible. Only include an example in the description section if absolutely necessary.
docs/query-help-style-guide.md:144
- Suggest clarifying that authors should not commit generated HTML (not Markdown) when writing native Markdown query help; the current wording may confuse manual vs. generated files.
Please include the query help files (and any associated code snippets) in your pull request, but do not commit the generated Markdown.
|
I based the updated guidance on a few java qhelp files, like this. I see there are also qhelp files for actions, like this, which have some small differences. We should decide which we way we want to go and standardize. In both cases the java ones are closer to the custom XML format.
|
1c54642 to
25adcc8
Compare
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.
We now support query help files formatted as markdown, but this was not documented. I have tried to update the documentation (with a lot of help from copilot). I am not particularly familiar with markdown query help files, so I may have got some things wrong.