Skip to content

Docs: Add missing return type to Avx512BW.ShiftRightArithmetic#130115

Open
winscripter wants to merge 1 commit into
dotnet:mainfrom
winscripter:fix/returntype-_mm512_sra_epi16
Open

Docs: Add missing return type to Avx512BW.ShiftRightArithmetic#130115
winscripter wants to merge 1 commit into
dotnet:mainfrom
winscripter:fix/returntype-_mm512_sra_epi16

Conversation

@winscripter

Copy link
Copy Markdown

Intrinsic methods, such as Sse2.Add, normally include a function prototype in the XML documentation. However, documentation for Avx512BW.ShiftRightArithmetic (line 1204-1205) lacks a return type. This PR includes a single commit which restores the return type in the ShiftRightArithmetic documentation (which is, according to a web search, __m512i).

Documentation for Avx512BW.ShiftRightArithmetic(Vector512<short> value, Vector128<short> count) was missing a return type. This commit updates the documentation to include the return type.
@dotnet-policy-service dotnet-policy-service Bot added the community-contribution Indicates that the PR has been added by a community member label Jul 2, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-runtime-intrinsics
See info in area-owners.md if you want to be subscribed.

@github-actions

github-actions Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

Workflow state for the Holistic Review Orchestrator.

{
  "version": 5,
  "last_dispatched_commit": "3909ccbe595143ad37a9a96d621f0652502cbbcd",
  "last_dispatched_base_ref": "main",
  "last_dispatched_base_sha": "8fe2929f5e365d262ca514854330c979fe6ab28b",
  "last_reviewed_commit": "3909ccbe595143ad37a9a96d621f0652502cbbcd",
  "last_reviewed_base_ref": "main",
  "last_reviewed_base_sha": "8fe2929f5e365d262ca514854330c979fe6ab28b",
  "last_recorded_worker_run_id": "29679147464",
  "review_attempt_commit": "",
  "review_attempt_base_ref": "",
  "review_attempt_count": 0,
  "max_review_attempts": 5,
  "review_history_format": "holistic-review-disclosure-v1",
  "review_history": [
    {
      "commit": "3909ccbe595143ad37a9a96d621f0652502cbbcd",
      "review_id": 4730521290
    }
  ]
}

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Holistic Review

Motivation: The XML documentation comment for Avx512BW.ShiftRightArithmetic(Vector512<short>, Vector128<short>) listed the intrinsic prototype without a return type (_mm512_sra_epi16 (__m512i a, __m128i count)), unlike every other shift intrinsic in the file, which prefix the prototype with its __m512i return type. This inconsistency is what the PR corrects.

Approach: A single one-line change adds the __m512i return type to the prototype <para>, producing __m512i _mm512_sra_epi16 (__m512i a, __m128i count). This is a documentation-only edit with no functional impact.

Summary: The fix is correct and consistent. Intel's intrinsics guide confirms _mm512_sra_epi16 returns __m512i, and this matches the exact formatting used by all adjacent shift intrinsics in the same file (e.g., _mm512_sll_epi16, _mm512_srl_epi16, _mm512_srav_epi16 at lines 1161-1261). There are no correctness, performance, security, or API concerns. No tests are needed for a documentation comment change. LGTM.

Note

This review was generated by this repository's Holistic Review agentic workflow to complement the built-in Copilot review.

Generated by Holistic Review · 33 AIC · ⌖ 9.44 AIC · ⊞ 10K

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

Labels

area-System.Runtime.Intrinsics community-contribution Indicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants