Rename HotCommands and DocComment #5524
Merged
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
Names were difficult to follow. Rename and match with existing public API documentation. Clean up IComPropertyBrowser (related).
dreddy-work
reviewed
Aug 25, 2021
src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/HelpPane.cs
Outdated
Show resolved
Hide resolved
...nitTests/System/Windows/Forms/PropertyGridInternal/HelpPane.HelpPaneAccessibleObjectTests.cs
Outdated
Show resolved
Hide resolved
src/System.Windows.Forms/src/System/Windows/Forms/PropertyGrid.cs
Outdated
Show resolved
Hide resolved
RussKie
previously approved these changes
Aug 25, 2021
src/System.Windows.Forms.Primitives/src/Interop/UiaCore/Interop.IRawElementProviderFragment.cs
Outdated
Show resolved
Hide resolved
...tem.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/IComPropertyBrowser.cs
Outdated
Show resolved
Hide resolved
...nitTests/System/Windows/Forms/PropertyGridInternal/HelpPane.HelpPaneAccessibleObjectTests.cs
Outdated
Show resolved
Hide resolved
|
x86 debug failed with #4736 |
|
This time |
dreddy-work
approved these changes
Aug 25, 2021
KlausLoeffelmann
approved these changes
Aug 25, 2021
| /// Returns the value of the specified <paramref name="propertyID"/> from the element. | ||
| /// </summary> | ||
| /// <param name="propertyID">Identifier indicating the property to return</param> | ||
| /// <returns>Returns the requested value if supported or null if it is not.</returns> |
| /// Returns the element in the specified <paramref name="direction"/>. | ||
| /// </summary> | ||
| /// <param name="direction">Indicates the direction in which to navigate.</param> | ||
| /// <returns>Returns the element in the specified direction if it exists.</returns> |
| @@ -6,30 +6,26 @@ | |||
|
|
|||
| namespace System.Windows.Forms.PropertyGridInternal | |||
| { | |||
| internal partial class DocComment | |||
| internal partial class HelpPane | |||
There was a problem hiding this comment.
So...this is the pane that shows the text which is defined by the DescriptionAttribute of a Property. Wouldn't therefore DescriptionPane a more intuitive name? (Not really sure myself, just thinking out loud.)
There was a problem hiding this comment.
I waffled. The other comments on the public API refer to this as "help" so I settled on that. PropertyGrid.HelpVisible.
| @@ -8,10 +8,18 @@ | |||
|
|
|||
| namespace System.Windows.Forms.PropertyGridInternal | |||
| { | |||
| internal partial class DocComment : PropertyGrid.SnappableControl | |||
| /// <summary> | |||
| /// The help (description) pane optionally shown at the bottom of the <see cref="PropertyGrid"/>. | |||
There was a problem hiding this comment.
Yeah, I put the parenthesis around it as we call it "description" in the UI. It felt better than description (help) given that we call this "help" in the public API. :)
|
I'll catch my missed comments in the next PR (up shortly). |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Names were difficult to follow. Rename and match with existing public API documentation. Clean up IComPropertyBrowser (related).
Microsoft Reviewers: Open in CodeFlow