Use .inc.qhelp extension for included help files
#5275
Merged
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
Marcono1234
commented
Feb 26, 2021
| ==================== | ||
|
|
||
| To reuse content between different help topics, you can store shared content in one query help file and then include it in a number of other query help files using the ``include`` element. The shared content can be stored either in the same directory as the including files, or in ``SEMMLE_DIST/docs/include``. | ||
| When a query help file is only included by other help files but does not belong to a specific query, it should have the file extension ``.inc.qhelp``. |
There was a problem hiding this comment.
Do you think it makes sense to include this? Any feedback is appreciated.
There was a problem hiding this comment.
I'm not on the documentation team, but this looks good to me 👍
Marcono1234
force-pushed
the
marcono1234/included-qhelp-files
branch
from
178c61d to
5a8ffa5
Compare
|
Looks like |
|
Ah right, though that file appears to be unused (#5274, unless I am overlooking something); should I simply delete it instead? |
It should actually be renamed to |
aschackmull
approved these changes
Mar 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Follow-up for #5226 (comment). This pull request updates the
.qhelpfiles only used inincludeby the other languages to use the extension.inc.qhelpas well.