JuliaArrays / JuliaArrays/StaticArrays.jl

export & document SUnitRange

Open
#620 4 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

design feature
Dominant language
Julia
Stars
844
Forks
159
Avg merge
3d 21h
Merged PRs (30d)
3

Description

StaticArrays.SUnitRange is very useful to unify code when I want a slice of an AbstractArray to be an SArray if the dimensions are known at compile time.

I wonder if it could be documented and exported, and thus made part of the API.

I am happy to make a PR, just wanted some feedback on this first. (Cf #32)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the existing SUnitRange definition and review the context in issue #32 first. Confirm what API documentation is needed and whether exporting it is appropriate; done means SUnitRange is documented and exported if the maintainers agree.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.