Several MemoryExtensions.LastIndexOfAnyExcept overloads incorrectly document "first occurrence"
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 83/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- csharp
調査の方向性
System.MemoryExtensions にある、列挙された MemoryExtensions.LastIndexOfAnyExcept<T> のオーバーロードの XML ドキュメントを開き、「first occurrence」という語句を検索します。近くのオーバーロードにも同じ文言がコピーされていないか確認します。該当する returns テキストを「last occurrence」に変更し、すべてのオーバーロードで文言が修正されたことを確認します。
索引モデルが issue の本文から書いたものです。
説明
Description
The XML documentation for several MemoryExtensions.LastIndexOfAnyExcept<T> overloads contains contradictory wording.
The method summaries correctly state that the methods search for the last index. However, their <returns> sections incorrectly say that the returned index is the index of the first occurrence:
The index in the span of the first occurrence of any value other than those in <paramref name="values"/>.
first occurrence should be changed to last occurrence.
Affected APIs
LastIndexOfAnyExcept<T>(this ReadOnlySpan<T> span, ReadOnlySpan<T> values) where T : IEquatable<T>?
LastIndexOfAnyExcept<T>(this ReadOnlySpan<T> span, ReadOnlySpan<T> values, IEqualityComparer<T>? comparer = null)
There may be additional overloads containing the same copied wording.
Reproduction Steps
- Open
System.MemoryExtensionsin thedotnet/runtimerepository. - Locate the XML documentation for the following overloads:
LastIndexOfAnyExcept<T>(this ReadOnlySpan<T> span, ReadOnlySpan<T> values) where T : IEquatable<T>?
LastIndexOfAnyExcept<T>(this ReadOnlySpan<T> span, ReadOnlySpan<T> values, IEqualityComparer<T>? comparer = null)
- Inspect the
<returns>documentation.
Expected behavior
The <returns> documentation should state that the method returns the index of the last occurrence of a value.
Actual behavior
The <returns> documentation incorrectly states that the method returns the index of the first occurrence of a value.
Regression?
No known regression. This appears to be an existing XML documentation error.
Known Workarounds
No response
Configuration
Not configuration-specific. This issue affects the XML documentation in System.MemoryExtensions.
Other information
No response
- 主要言語
- C#
- スター
- 18.4k
- フォーク
- 5.7k
- 平均マージ
- 2日 19時間
- マージ済み PR(30日)
- 649
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
dotnet/runtime のほかの issue
-
[mono] Native memory leak on the first invoke of every open-instance delegate to a virtual methodオープンarea-VM-meta-mono untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
dotnet/runtime#136284 · リアクション 6 件 ·
メンテナーはふだん 1 日以内に返信
-
MemoryExtensions.LastIndexOf ignores a custom comparer for bitwise-equatable element types対応中かも @aw0lid が今日担当しました。 オープンarea-System.Runtime untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
dotnet/runtime#136281 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
area-System.IO.Compression untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
dotnet/runtime#136215 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
area-CodeGen-coreclr untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
dotnet/runtime#135849 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[wasm] Emscripten clang wrapper fails when the SDK path contains a space対応中かも @agocke が 14 日前に担当しました。 オープンarch-wasm area-Infrastructure untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
dotnet/runtime#135416 · コメント 2 件 · リアクション 2 件 · 担当者 2 名 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
dev/release: verify-release-candidate.sh runs 0 Java tests with Debian's Maven対応中かも @kou が今日担当しました。 オープンType: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
apache/arrow-adbc#4947 ·
メンテナーはふだん 1 日以内に返信
-
:watch: Not Triaged CAC
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
dotnet/AspNetCore.Docs#38001 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Nimblesite/SharpLsp#468 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
elastic/ecs-dotnet#575 ·
-
alerts bug effort:S P2
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
nightscout/nocturne#2511 ·
メンテナーはふだん 1 日以内に返信