Random doc updates #7476
Open
Random doc updates #7476
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR refines XML documentation across several text and transformer components, improving grammar, clarity, and example references.
- Standardizes summary and
<param>XML tags to use action verbs (e.g., “Creates”, “Gets or sets”). - Improves phrasing and adds
<remarks>and explicit<see>links for usage examples. - Corrects hyphenation and list punctuation in descriptions.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Microsoft.ML.Transforms.Text/TextFeaturizingEstimator.cs | Refined XML comments: grammar fixes, added <remarks> and <see> links |
| src/Microsoft.ML.Transforms/CustomMappingTransformer.cs | Enhanced <param> descriptions for better clarity |
| src/Microsoft.ML.Transforms/CategoricalCatalog.cs | Standardized summary XML to use action verbs |
Comments suppressed due to low confidence (1)
src/Microsoft.ML.Transforms.Text/TextFeaturizingEstimator.cs:213
- Since
Normis a public field that can be assigned, consider updating the summary to "Gets or sets the norm of the output vector. It will be normalized to one." to accurately reflect its mutability.
Gets the norm of the output vector. It will be normalized to one.
gewarren
commented
Jun 10, 2025
ericstj
approved these changes
Jun 12, 2025
Comment on lines
+36
to
+43
| /// <summary> | ||
| /// Creates a custom mapping of input columns to output columns. | ||
| /// </summary> | ||
| /// <param name="env">The host environment that provides services and logging capabilities.</param> | ||
| /// <param name="mapAction">The action that maps source columns to destination columns.</param> | ||
| /// <param name="contractName">The name of the action that will be saved to the model.</param> | ||
| /// <param name="inputSchemaDefinition">Additional parameters for schema mapping between <typeparamref name="TSrc"/> and input data.</param> | ||
| /// <param name="outputSchemaDefinition">Additional parameters for schema mapping between <typeparamref name="TDst"/> and output data.</param> |
There was a problem hiding this comment.
nit: indenting off -- also this is internal. Did you mean to change it?
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.
Follow up to dotnet/ml-api-docs#175 and other grammar improvements.
So we can do the best job, please check:
Fixes #nnnnin your description to cause GitHub to automatically close the issue(s) when your PR is merged.