JuliaLang/julia

Improve reinterpret docstring

Open

#47,706 opened on 2022年11月25日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Julia (48,709 stars) (5,773 forks)batch import
docshelp wanted

説明

reinterpret(type, A) The docstring does not mention what types are allowed in type. I believe it is any type that isbitstype or eltype(A) itself, regardless of whether or not it is a bits type, but I'm not sure.

Additionally, in Julia 1.8.3 and 1.6.3, this works: reinterpret(Real, Real[1,2,3]). In Julia 1.0.5, it throws. Perhaps this warrants a compat entry? Or perhaps 1.0 is too far gone for that.

コントリビューターガイド

技術スタック
なし
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic understanding of Julia types
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
The docstring for `reinterpret` in Julia's base library (likely in `base/abstractarray.jl`) needs to specify which types are allowed for the `type` argument. The issue author suggests it accepts any type that `isbitstype` or `eltype(A)` itself. Verify this behavior by reading the implementation and testing with various types. Also, consider adding a compat note for the behavior change across Julia versions (works in 1.6/1.8 but not 1.0). The existing comments should be reviewed for additional context.