JuliaLang/julia

Improve reinterpret docstring

Open

#47,706 opened on Nov 25, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Julia (5,773 forks)batch import
docshelp wanted

Repository metrics

Stars
 (48,709 stars)
PR merge metrics
 (Avg merge 20d 6h) (157 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Examine the source code of `reinterpret` to understand which types are accepted, and then update the docstring accordingly. Also check the compatibility notes for Julia 1.0 vs later versions.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80