Remove .NET Framework remarks (System.Management)#12653
Open
gewarren wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the System.Management API reference XML to remove .NET Framework-specific content (notably CAS/.NET Framework security remarks), while also normalizing some remarks/value text and tidying markdown formatting around examples.
Changes:
- Removed “.NET Framework Security” sections and other framework-specific notes across many
System.Managementtypes/members. - Simplified/normalized
<value>and<remarks>text, including some example/markdown formatting cleanup. - Introduced placeholder remarks in multiple places (
<remarks>To be added.</remarks>) where remarks were removed.
Reviewed changes
Copilot reviewed 46 out of 46 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Management/WqlObjectQuery.xml | Removes framework security remarks; adds placeholder remarks. |
| xml/System.Management/WqlEventQuery.xml | Removes framework security remarks; adjusts <value>/remarks and examples formatting. |
| xml/System.Management/StoppedEventArgs.xml | Removes framework security remarks; adds placeholder remarks. |
| xml/System.Management/SelectQuery.xml | Removes framework security remarks; adjusts <value> text. |
| xml/System.Management/RelationshipQuery.xml | Removes framework security remarks; cleans up markdown/example formatting; adds placeholders. |
| xml/System.Management/RelatedObjectQuery.xml | Removes framework security remarks; cleans up markdown/example formatting; adds placeholders. |
| xml/System.Management/QualifierDataCollection+QualifierDataEnumerator.xml | Removes framework security remarks; cleans up examples formatting; adds placeholders. |
| xml/System.Management/QualifierDataCollection.xml | Removes framework security remarks; adds placeholder remarks and trims property value sections. |
| xml/System.Management/QualifierData.xml | Removes framework security remarks; cleans up examples formatting; adds placeholder remarks in several members. |
| xml/System.Management/PutOptions.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/PropertyDataCollection+PropertyDataEnumerator.xml | Removes framework security remarks; cleans up examples formatting; adds placeholders. |
| xml/System.Management/PropertyDataCollection.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/PropertyData.xml | Removes framework security remarks; cleans up examples formatting; adds placeholder remarks in several members. |
| xml/System.Management/ProgressEventArgs.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/ObjectReadyEventArgs.xml | Removes framework security remarks; adjusts <summary>/<value>; adds placeholder remarks. |
| xml/System.Management/ObjectQuery.xml | Removes framework security remarks; adds placeholder remarks; minor whitespace cleanup. |
| xml/System.Management/ObjectPutEventArgs.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/ObjectGetOptions.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/MethodDataCollection+MethodDataEnumerator.xml | Removes framework security remarks; cleans up examples formatting; adds placeholders. |
| xml/System.Management/MethodDataCollection.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/MethodData.xml | Removes framework security remarks/property value sections; adjusts <value> text. |
| xml/System.Management/ManagementScope.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/ManagementQuery.xml | Removes framework security remarks; adds placeholders; cleans up markdown formatting. |
| xml/System.Management/ManagementPath.xml | Removes framework security remarks; adjusts <value> text; cleans up examples formatting; adds placeholders. |
| xml/System.Management/ManagementOptions.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/ManagementOperationObserver.xml | Removes framework security remarks; adds placeholders; minor formatting cleanup. |
| xml/System.Management/ManagementObjectSearcher.xml | Removes framework security remarks; adds placeholders; minor markdown formatting cleanup. |
| xml/System.Management/ManagementObjectCollection+ManagementObjectEnumerator.xml | Removes framework security remarks; adds placeholders. |
| xml/System.Management/ManagementObjectCollection.xml | Removes framework security remarks; adds placeholders; modifies Count remarks. |
| xml/System.Management/ManagementNamedValueCollection.xml | Removes framework security remarks; adds placeholder remarks. |
| xml/System.Management/ManagementException.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/ManagementEventWatcher.xml | Removes framework security remarks; adds placeholders; minor markdown formatting cleanup. |
| xml/System.Management/ManagementEventArgs.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/ManagementDateTimeConverter.xml | Removes framework security remarks; minor text formatting changes in remarks. |
| xml/System.Management/ManagementBaseObject.xml | Removes framework security remarks/property value sections; edits remarks and indexer summary/value text. |
| xml/System.Management/InvokeMethodOptions.xml | Removes framework security remarks; cleans up examples formatting; adds placeholders. |
| xml/System.Management/EventWatcherOptions.xml | Removes framework security remarks; adjusts <value> text; adds placeholders. |
| xml/System.Management/EventQuery.xml | Removes framework security remarks; adds placeholders. |
| xml/System.Management/EventArrivedEventHandler.xml | Cleans up examples formatting and updates wording to remove framework-specific phrasing. |
| xml/System.Management/EventArrivedEventArgs.xml | Removes framework security remarks; cleans up examples formatting; adds placeholders. |
| xml/System.Management/EnumerationOptions.xml | Removes framework security remarks; adjusts <value> text; cleans up examples formatting; adds placeholders. |
| xml/System.Management/DeleteOptions.xml | Removes framework security remarks; adds placeholders. |
| xml/System.Management/ConnectionOptions.xml | Removes framework security remarks; refactors remarks text and <value> strings. |
| xml/System.Management/CompletedEventArgs.xml | Removes framework security remarks; adjusts <summary>/<value>; adds placeholders. |
| <Docs> | ||
| <summary>Sets the password for the specified user.</summary> | ||
| <value>Returns a <see cref="T:System.String" /> value used for the password in a connection to WMI.</value> | ||
| <value>The password in a connection to WMI. The default value is <see langword="null" />. If the user name is also <see langword="null" />, the credentials used will be thoseof the currently logged-on user are used.</value> |
| <Docs> | ||
| <summary>Gets or sets the user name to be used for the connection operation.</summary> | ||
| <value>Returns a <see cref="T:System.String" /> value used as the user name in a connection to WMI.</value> | ||
| <value>The user name in a connection to WMI. The default value is <see langword="null" />. If <see langword="null" />, the credentials used will be those of the currently logged-on user are used.</value> |
Comment on lines
413
to
+415
| <Docs> | ||
| <summary>Ggets or sets an array of property names to be selected in the query.</summary> | ||
| <value>Returns a <see cref="T:System.Collections.Specialized.StringCollection" /> containing the names of the properties to be selected in the query.</value> | ||
| <value>The names of the properties to be selected in the query.</value> |
|
|
||
| ## .NET Framework security | ||
| Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). | ||
| The resulting DMTF datetime string is based on the UTC offset of the current time zone. The lowest precision in DMTF is microseconds; in <xref:System.DateTime>, the lowest precision is <xref:System.DateTime.Ticks*>, which are equivalent to 100 nanoseconds. During conversion, <xref:System.DateTime.Ticks*> are converted to microseconds and rounded off to the nearest microsecond |
Comment on lines
137
to
140
| ## Remarks | ||
|
|
||
| The lowest precision in DMTF is microseconds; in <xref:System.TimeSpan>, the lowest precision is <xref:System.TimeSpan.Ticks*>, which is equivalent to 100 nanoseconds. During conversion, <xref:System.TimeSpan.Ticks*> are converted to microseconds and rounded off to the nearest microsecond. | ||
|
|
||
| ## .NET Framework security | ||
| Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). | ||
| The lowest precision in DMTF is microseconds; in <xref:System.TimeSpan>, the lowest precision is <xref:System.TimeSpan.Ticks*>, which is equivalent to 100 nanoseconds. During conversion, <xref:System.TimeSpan.Ticks*> are converted to microseconds and rounded off to the nearest microsecond | ||
|
|
| Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). | ||
|
|
||
|
|
||
| Currently, the only format that WMI supports is *Managed Object Format* (MOF) |
Comment on lines
449
to
453
| </ReturnValue> | ||
| <Docs> | ||
| <summary>Gets or sets the interval to be used for grouping events of the same type.</summary> | ||
| <value>Returns a <see cref="T:System.TimeSpan" /> value containing the interval used for grouping events of the same type.</value> | ||
| <value>The interval used for grouping events of the same type, or <see langword="null" /> if no grouping is required.</value> | ||
| <remarks> |
Comment on lines
599
to
602
| <Docs> | ||
| <summary>Gets or sets the polling interval to be used in this query.</summary> | ||
| <value>Returns a <see cref="T:System.TimeSpan" /> value containing the polling interval used in the event query.</value> | ||
| <value>The polling interval used in the event query, if polling is required; otherwise, <see langword="null" />.</value> | ||
| <remarks> |
Comment on lines
53
to
56
| <Docs> | ||
| <summary>Initializes a new instance of the <see cref="T:System.Management.WqlObjectQuery" /> class. This is the parameterless constructor.</summary> | ||
| <remarks> | ||
| <format type="text/markdown"><. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> |
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <value>The extended error information, if available; otherwise, <c>null</c>.</value> |
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
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.
.NET Framework API ref has moved to its own repo (https://github.com/dotnet/dotnetfw-api-docs), so we can clean up .NET Framework remarks, exceptions, and code examples out of this repo. Contributes to #12513.
Removes remarks and examples related to:
Also remarks all remarks from obsolete APIs.
Hide whitespace changes