Skip to content

Conversation

@mbauman
Copy link
Member

@mbauman mbauman commented Nov 19, 2018

Following #29167 I reviewed the array assignment section of the documentation:

  • Incorporates the changes I suggested there
  • More carefully explain scalar assignment (and the conversion that occurs)
  • Lead with the shape of the indices instead of the shape of the value
  • And as a minor stylistic thing, use unicode subscripts like Iₖ instead of I_k

More carefully explain the scalar case, and lead with the shape of the indices to drive the discussion
@mbauman mbauman added the docs This change adds or pertains to documentation label Nov 19, 2018
@mbauman mbauman force-pushed the mb/more-array-indexing-docs branch from f9b8a3c to 08e1bfc Compare November 19, 2018 22:45
@jmkuhn
Copy link
Contributor

jmkuhn commented Nov 20, 2018

In general I don't have issues with displaying unicode characters but it appears Macs don't ship with any fonts that include latin subscript small letter k or n (the subscript numbers are fine). This could make it more difficult for some users to read the documentation.

@mbauman
Copy link
Member Author

mbauman commented Nov 20, 2018

Bummer. I find I₁[i₁], I₂[i₂], ..., Iₙ[iₙ] far more readable than I_1[i_1], I_2[i_2], ..., I_n[i_n]. But thanks for reporting that — it is important. Viewing the subscript/superscript page on my iPhone, it looks like we're limited to: ₐₑᵢⱼₒᵣᵤᵥₓᵦᵧᵨᵩᵪ. We could use Iₓ for the arbitrary I_k, but we don't really have a good replacement for I_n. As if Unicode's dearth of subscript support wasn't enough…

This is why we cannot have nice things.

@JeffBezanson
Copy link
Member

Are you planning to change back the subscripts, or should this be merged as-is?

@mbauman
Copy link
Member Author

mbauman commented Nov 30, 2018

I'll change them back.

@mbauman mbauman merged commit fcd031b into master Dec 6, 2018
@mbauman mbauman deleted the mb/more-array-indexing-docs branch December 6, 2018 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs This change adds or pertains to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants