[Chapel Merge] Add more rationale for abstract intents and reform

Notifications Commits
1

Branch: refs/heads/main
Revision: 404e5ca
Author: bradcray
Link: Add more rationale for abstract intents and reformat table by bradcray · Pull Request #20700 · chapel-lang/chapel · GitHub
Log Message:

Merge pull request #20700 from bradcray/abstract-intent-rationale-table-refactor

Add more rationale for abstract intents and reformat table

[reviewed by @mppf]

A user recently lamented the need to memorize or constantly refer back to the table defining abstract intents for various types. When I verbally gave the rules of thumb that define the table, they said "Oh, maybe the spec should just say that," which was a great point.

Here, I've:

  • added a rationale for the blank intent (the const intent already had some)

  • combined rows of the table that are similar and have equivalent behavior to make it shorter / less overwhelming / easier to digest and see patterns in

  • reordered rows to put more common types earlier and more similar types together

  • taken control over the column widths and line breaks to make things read more cleanly

  • moved the sections describing the const and blank intents before the table to put the rationale first before someone gets distracted by the table and stops reading.

  • made general wording changes / improvements.

    Modified Files:
    M doc/rst/language/spec/procedures.rst

    Compare: Comparing 0ca1166e1894...404e5caa96d1 · chapel-lang/chapel · GitHub