Improve some comments related to topicpull XSLT parameters #4176
Conversation
This file contains 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
chrispy-snps
changed the title
chrispy-snps
force-pushed
the
enhancement/topicpull-param-comments
branch
from
413cb00
to
3e0eaab
Compare
jelovirt
force-pushed
the
enhancement/topicpull-param-comments
branch
from
3e0eaab
to
9fcb0d2
Compare
robander
previously approved these changes
Apr 26, 2023
robander
reviewed
Apr 26, 2023
| <xsl:param name="TABLELINK">NUMBER</xsl:param> | ||
| <xsl:param name="FIGURELINK">NUMBER</xsl:param> | ||
| <xsl:param name="remove-broken-links" as="xs:string?"/> | ||
| <xsl:param name="TABLELINK" as="xs:string" select="'NUMBER'"/> <!-- DITA-OT parameter args.tablelink.style: 'NUMBER' or 'TITLE' --> |
There was a problem hiding this comment.
@chrispy-snps I marked this approved because I'm fine with the code comments - but would it be possible to move the code comment to the line above? I worry about a future code linting tool that will move the comment to the next line, and you end up with
<xsl:param name="FIGURELINK" as="xs:string" select="'NUMBER'"/>
<!-- DITA-OT parameter args.figurelink.style: 'NUMBER' or 'TITLE' -->
<xsl:param name="remove-broken-links" as="xs:string" select="'false'"/>
There was a problem hiding this comment.
Updated to request that change -- other than that LGTM
chrispy-snps
force-pushed
the
enhancement/topicpull-param-comments
branch
from
9fcb0d2
to
801a7ad
Compare
Signed-off-by: chrispy <chrispy@synopsys.com>
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
jelovirt
force-pushed
the
enhancement/topicpull-param-comments
branch
from
801a7ad
to
3521e2a
Compare
jelovirt
added
priority/low
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.
Description
This pull request adds/updates some parameter-related comments in the topicpullImpl.xsl file.
Motivation and Context
This started when I noticed an outdated comment that a
$tbltitletemplate parameter was not used (it is). After fixing that, I also added/updated some other parameter-related comments while tracing through the code.How Has This Been Tested?
All tests pass. I also manually tested
<xref>and<link>references to<table>and<figure>elements with the parameters set to both values.Type of Changes
These are comments only; no functionality is affected.
Documentation and Compatibility
No documentation or release notes are needed.
Checklist
I tried to follow the format of existing comments in other preprocessing stylesheets.