Skip to content

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Random doc updates #7476

wants to merge 2 commits into from

Conversation

gewarren
Copy link
Contributor

@gewarren gewarren commented Jun 5, 2025

Follow up to dotnet/ml-api-docs#175 and other grammar improvements.

So we can do the best job, please check:

  • There's a descriptive title that will make sense to other developers some time from now.
  • There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
  • Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
  • You have included any necessary tests in the same PR.

@Copilot Copilot AI review requested due to automatic review settings June 5, 2025 22:02
Copy link
Contributor

@Copilot Copilot AI left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant