Add tooltips for hashtable key completions #17864

MartinGC94 · 2022-08-09T23:39:26Z

PR Summary

Add tooltips for hashtable key completions
Use resource files instead of dictionary for comment completion tooltips

PR Context

PR Checklist

Add completion for calculated properties for Compare-Object and ConvertTo-HTML Add argument completer for the Property parameter of ConvertTo-Html Use resource files instead of dictionary for comment completion tooltips

src/System.Management.Automation/resources/TabCompletionStrings.resx

src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs

ghost · 2022-08-19T14:01:28Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

TravisEz13 · 2023-05-08T18:57:58Z

@daxian-dbw Can you review?

ghost · 2023-05-16T02:00:52Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1

pull-request-quantifier-deprecated · 2023-06-19T18:26:29Z

This PR has 360 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Large
Size       : +315 -45
Percentile : 76%

Total files changed: 3

Change summary by file extension:
.cs : +85 -28
.resx : +212 -0
.ps1 : +18 -17

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

iSazonov · 2025-03-20T09:46:11Z

@MartinGC94 Are all these changes related, or can you break them down into different PRs?

MartinGC94 · 2025-03-20T19:13:08Z

@iSazonov Everything except the additional switch cases for Compare-Object and ConvertTo-Html are related. I can pull out those changes but it's like 10 lines of code that we "save" on that, so not sure if it's worth it, but it's up to you.

-Edit: I changed my mind and removed the irrelevant changes. The PR could be further split into tooltips for hashtables, and updating the tooltips for help keywords to use the resource file but then I'd have to deal with annoying merge conflicts so I'd prefer not to.

src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs

src/System.Management.Automation/resources/TabCompletionStrings.resx

iSazonov · 2025-03-24T11:12:12Z

src/System.Management.Automation/resources/TabCompletionStrings.resx

+  </data>
+  <data name="DepthHashtableKeyDescription" xml:space="preserve">
+    <value>[int]
+The depth key allows you to specify the depth of expansion per property.</value>


Please reword like:

Suggested change

The depth key allows you to specify the depth of expansion per property.</value>

The depth key specifies the depth of expansion per property.</value>

iSazonov · 2025-03-24T11:12:30Z

src/System.Management.Automation/resources/TabCompletionStrings.resx

+  </data>
+  <data name="AscendingHashtableKeyDescription" xml:space="preserve">
+    <value>[bool]
+Allows you to specify the order of sorting for one or more properties.</value>


iSazonov · 2025-03-24T11:12:42Z

src/System.Management.Automation/resources/TabCompletionStrings.resx

+  </data>
+  <data name="DescendingHashtableKeyDescription" xml:space="preserve">
+    <value>[bool]
+Allows you to specify the order of sorting for one or more properties.</value>


iSazonov · 2025-03-24T11:16:04Z

src/System.Management.Automation/resources/TabCompletionStrings.resx

+  </data>
+  <data name="DataHashtableKeyDescription" xml:space="preserve">
+    <value>[string[]]
+Selects events with any of the specified values in the EventData section.</value>


Can we add an example in the help?

The tooltips generally don't have examples. I'm also not sure how much value there would be in something like: Get-WinEvent -FilterHashtable @{LogName="System";ID=7040;Data="BITS"} because unless you happen to have the raw event data in front of you, you won't know what field "BITS" refers to. The same goes for the SuppressHashFilter suggestion.

iSazonov · 2025-03-24T11:17:41Z

src/System.Management.Automation/resources/TabCompletionStrings.resx

+  </data>  
+  <data name="SuppressHashFilterHashtableKeyDescription" xml:space="preserve">
+    <value>[hashtable]
+Excludes events that match the values specified in the hashtable.</value>


iSazonov · 2025-03-24T11:23:49Z

src/System.Management.Automation/resources/TabCompletionStrings.resx

+  <data name="CommentHelpSYNOPSISKeywordDescription" xml:space="preserve">
+    <value>A brief description of the function or script.
+This keyword can be used only once in each topic.</value>
+  </data>
+  <data name="CommentHelpDESCRIPTIONKeywordDescription" xml:space="preserve">
+    <value>A detailed description of the function or script.
+This keyword can be used only once in each topic.</value>
+  </data>
+  <data name="CommentHelpPARAMETERKeywordDescription" xml:space="preserve">
+    <value>.PARAMETER  &lt;Parameter-Name&gt;
+The description of a parameter.
+Add a .PARAMETER keyword for each parameter in the function or script syntax.</value>
+  </data>


Maybe use the same pattern started with keyword everywhere?

Do you mean replacing all the *HashtableKeyDescription instances with HashtableKeyDescription*? (Example: StartTimeHashtableKeyDescription -> HashtableKeyDescriptionStartTime)

I mean .PARAMETER in help text.

I see. The point of .PARAMETER <Parameter-Name> is to show the required syntax. I use it for all the help keywords that take some sort of parameter, for example: EXTERNALHELP and FORWARDHELPCATEGORY. For the help keywords that don't take any arguments (SYNOPSIS and others) I don't see any reason to include an extra line with just the keyword.

iSazonov · 2025-03-25T03:52:12Z

/azp run

azure-pipelines · 2025-03-25T03:52:23Z

Azure Pipelines successfully started running 1 pipeline(s).

microsoft-github-policy-service · 2025-03-25T05:14:48Z

📣 Hey @MartinGC94, how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://aka.ms/PSRepoFeedback

Microsoft Forms

Add tooltips for hashtable key completions

4ec67ca

Add completion for calculated properties for Compare-Object and ConvertTo-HTML Add argument completer for the Property parameter of ConvertTo-Html Use resource files instead of dictionary for comment completion tooltips

ghost assigned TravisEz13 Aug 9, 2022

pull-request-quantifier-deprecated bot added the Large label Aug 9, 2022

Fix tests

da04c6f

MartinGC94 closed this Aug 10, 2022

MartinGC94 reopened this Aug 10, 2022

iSazonov reviewed Aug 11, 2022

View reviewed changes

iSazonov requested a review from daxian-dbw August 11, 2022 10:15

ghost added the Review - Needed The PR is being reviewed label Aug 19, 2022

MartinGC94 and others added 5 commits January 19, 2023 00:49

Merge branch 'master' into FixToolTips

1caafd4

Merge branch 'master' into FixToolTips

b0c54c4

Fix merge issues.

e8104e8

Fix merge another merge conflict.

98adf49

Fix test

2c20a42

MartinGC94 closed this May 3, 2023

MartinGC94 reopened this May 3, 2023

ghost removed the Review - Needed The PR is being reviewed label May 8, 2023

ghost added the Review - Needed The PR is being reviewed label May 16, 2023

JamesWTruher reviewed Jun 12, 2023

View reviewed changes

test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1 Outdated Show resolved Hide resolved

Sort results and add tooltip test.

2a04d1a

microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Mar 20, 2025

Merge branch 'PowerShell:master' into FixToolTips

34f01c6

MartinGC94 added 2 commits March 20, 2025 21:17

Remove irrelevant changes

8a58373

Use suggesed pattern to get tooltips

8d18d03

iSazonov reviewed Mar 24, 2025

View reviewed changes

Address feedback

c6df517

iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Mar 24, 2025

This comment was marked as outdated.

Sign in to view

iSazonov reviewed Mar 24, 2025

View reviewed changes

Address feedback

cb2474b

iSazonov approved these changes Mar 25, 2025

View reviewed changes

iSazonov assigned iSazonov and unassigned TravisEz13 Mar 25, 2025

iSazonov enabled auto-merge (squash) March 25, 2025 05:11

iSazonov merged commit 1ac3ff1 into PowerShell:master Mar 25, 2025
38 of 40 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add tooltips for hashtable key completions #17864

Add tooltips for hashtable key completions #17864

MartinGC94 commented Aug 9, 2022 •

edited

Loading

ghost commented Aug 19, 2022

TravisEz13 commented May 8, 2023

ghost commented May 16, 2023

pull-request-quantifier-deprecated bot commented Jun 19, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

iSazonov commented Mar 20, 2025

MartinGC94 commented Mar 20, 2025 •

edited

Loading

This comment was marked as outdated.

This comment was marked as outdated.

iSazonov Mar 24, 2025

iSazonov Mar 24, 2025

iSazonov Mar 24, 2025

iSazonov Mar 24, 2025

MartinGC94 Mar 24, 2025

iSazonov Mar 24, 2025

iSazonov Mar 24, 2025

MartinGC94 Mar 24, 2025

iSazonov Mar 24, 2025

MartinGC94 Mar 24, 2025

iSazonov commented Mar 25, 2025

azure-pipelines bot commented Mar 25, 2025

microsoft-github-policy-service bot commented Mar 25, 2025 •

edited by unfurl-links bot

Loading

	The depth key allows you to specify the depth of expansion per property.</value>
	The depth key specifies the depth of expansion per property.</value>

Add tooltips for hashtable key completions #17864

Add tooltips for hashtable key completions #17864

Conversation

MartinGC94 commented Aug 9, 2022 • edited Loading

PR Summary

PR Context

PR Checklist

ghost commented Aug 19, 2022

TravisEz13 commented May 8, 2023

ghost commented May 16, 2023

pull-request-quantifier-deprecated bot commented Jun 19, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

iSazonov commented Mar 20, 2025

MartinGC94 commented Mar 20, 2025 • edited Loading

This comment was marked as outdated.

This comment was marked as outdated.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iSazonov commented Mar 25, 2025

azure-pipelines bot commented Mar 25, 2025

microsoft-github-policy-service bot commented Mar 25, 2025 • edited by unfurl-links bot Loading

MartinGC94 commented Aug 9, 2022 •

edited

Loading

MartinGC94 commented Mar 20, 2025 •

edited

Loading

microsoft-github-policy-service bot commented Mar 25, 2025 •

edited by unfurl-links bot

Loading