-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Random doc updates #7476
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Random doc updates #7476
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
Norm
is 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small nit
This reverts commit 017e001.
…g into some-doc-updates
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7476 +/- ##
=======================================
Coverage 68.99% 68.99%
=======================================
Files 1482 1482
Lines 273880 273880
Branches 28254 28254
=======================================
+ Hits 188956 188975 +19
+ Misses 77540 77522 -18
+ Partials 7384 7383 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
@ericstj Can you merge it when you get a chance? |
Follow up to dotnet/ml-api-docs#175 and other grammar improvements.
So we can do the best job, please check:
Fixes #nnnn
in your description to cause GitHub to automatically close the issue(s) when your PR is merged.