numpy icon indicating copy to clipboard operation
numpy copied to clipboard

DOC: Add documentation explaining our promotion rules

Open seberg opened this issue 1 year ago • 0 comments

This adds a dedicated page about promotion rules.


Please don't hesitate to rip it apart, I haven't tried to really iterate yet, but I think it would be useful to get feedback. (Also don't hesitate to push changes/fixes!)

My thought was to try and not dwell too long on the technical details, but start with the things that I thought are more interesting to very new users. That might mean the plot (taken from the NEP, but without the text), may be a little bit underexplained.

There is also the question if more examples would be relevant, although I don't really want to overdo it (in the NEP the big table is important, for a new user with fresh eyes, I am not quite sure what is.)

I need to figure out if we have any docs that need to be removed/refer here (beyond result_type, promote_types`, and maybe the release note/migration guide as a link).

Doctest will probably fail for now, and references might be bad... let's fix it as we iterate


@mdhaber maybe you can have a look?

seberg avatar Jan 27 '24 13:01 seberg