Skip to content

Add xml summary comments and argument validation to CpuMathUtils #1265

Closed

Description

@eerhardt

Our CpuMathUtils class is public with public methods, but we don't have any xml summary comments, and only use asserts for argument checking.

Since these are public members, we should have xml doc comments and real argument checking.

See example:

}
public static void Add(float a, float[] dst, int count)
{
Contracts.AssertNonEmpty(dst);
Contracts.Assert(count > 0);
Contracts.Assert(count <= dst.Length);
Add(a, new Span<float>(dst, 0, count));
}

Also, see PR comment here: #1229 (comment)

Activity

  1. ghost locked as resolved and limited conversation to collaborators on Mar 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationRelated to documentation of ML.NETenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions