julia icon indicating copy to clipboard operation
julia copied to clipboard

Mark `require_one_based_indexing` and `has_offset_axes` as public

Open adrhill opened this issue 1 year ago • 3 comments

The discussion here mentions require_one_based_indexing being part of the public API: https://github.com/JuliaLang/julia/pull/43263

Both functions are also documented (albeit in the dev docs):

  • require_one_based_indexing: https://docs.julialang.org/en/v1/devdocs/offset-arrays/#man-custom-indices
  • has_offset_axes: https://docs.julialang.org/en/v1/devdocs/offset-arrays/#For-objects-that-mimic-AbstractArray-but-are-not-subtypes

Towards https://github.com/JuliaLang/julia/issues/51335.

adrhill avatar Oct 16 '24 15:10 adrhill

Both functions are also documented (albeit in the dev docs)

It'd be much better to have them documented outside of the devdocs though.

giordano avatar Oct 16 '24 22:10 giordano

Do you want me to include them somewhere? I'm not sure which section in docs.julialang.org/en/v1/base/arrays/ is best suited. Maybe "Array functions"?

adrhill avatar Oct 17 '24 11:10 adrhill

"Indexing and assignment" is probably a better fit.

adrhill avatar Oct 17 '24 14:10 adrhill

Tagging triage because this adds new API.

LilithHafner avatar Oct 22 '24 13:10 LilithHafner

Two approvals, 6 +1s on the OP and no blocking comments seems plenty to bypass triage. @mbauman, are you okay with merging this PR despite your lack of excitement?

LilithHafner avatar Oct 25 '24 12:10 LilithHafner