JuliaCollections / JuliaCollections/AbstractTrees.jl
Avoid or clarify possible pun on `Base.parent`
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 243
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Description
The definition doesn't seem to be used, and I'm not sure what it illustrates. In any case, this seems to be a pun on Base.parent:
help?> parent
[...]
parent(A)
Return the underlying "parent array”. This parent array of objects of types SubArray, ReshapedArray or LinearAlgebra.Transpose is what was passed as an argument to view, reshape,
transpose, etc. during object creation. If the input is not a wrapped object, return the input itself.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at examples/binarytree_infer.jl line 36 and read the surrounding example to determine whether the definition is used and what it illustrates. Compare its naming with Julia's Base.parent documentation, then clarify the explanation or remove the potentially confusing pun so the example's purpose is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100