Unify column short description and description - #441
Closed
Jing Xia (xj-ms) wants to merge 1 commit into
Closed
Conversation
Jing Xia (xj-ms)
requested review from
helenkzhang,
Jayson Maxson (jmaxson-ms),
malavshah11 and
Tristan Gibeau (trgibeau)
as code owners
August 8, 2026 01:27
Jing Xia (xj-ms)
force-pushed
the
user/jing/column-description
branch
from
August 8, 2026 01:38
dcb68e0 to
2acaa52
Compare
Jing Xia (xj-ms)
force-pushed
the
user/jing/column-description
branch
from
August 8, 2026 03:01
2acaa52 to
8e482fc
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
All existing Xperf columns use either Description or ShortDescription. These 2 properties are basically interchangeable in reality.
Their distinction is not described and unclear to both the plugin authors and consumers.
In many places, we only consume one but not the other.
Instead of making the consumers having to decide which to use (or by checking whether the description equals to the column name), we can just unify them in the SDK