Update the spec and primers for range and const changes #22565
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Vassily Litvinov <vasslitvinov@users.noreply.github.com>
Signed-off-by: Vassily Litvinov <vasslitvinov@users.noreply.github.com>
benharsh
approved these changes
Jun 15, 2023
doc/rst/language/spec/domains.rst
Outdated
| @@ -181,7 +177,7 @@ The syntax of a rectangular domain type is summarized as follows: | |||
| 'domain' ( named-expression-list ) | |||
|
|
|||
| where ``named-expression-list`` permits the values of ``rank``, | |||
| ``idxType``, and ``stridable`` to be specified using standard type | |||
| ``idxType``, and ``strides`` to be specified using standard type | |||
There was a problem hiding this comment.
The previous grammar of "... using standard type signature" seems a bit odd here. I think we could just get rid of that and have the sentence end with "to be specified".
doc/rst/language/spec/domains.rst
Outdated
| @@ -249,8 +244,8 @@ The type of a rectangular domain literal is defined as follows: | |||
|
|
|||
| - ``idxType`` = the type of the range expressions; | |||
|
|
|||
| - ``stridable`` = ``true`` if any of the range expressions are | |||
| stridable, otherwise ``false``. | |||
| - ``strides`` = the most specific value that accepts all the strides | |||
There was a problem hiding this comment.
Suggested rewording:
the most narrow :enum:strideKind that can represent all strides parameters of the range expressions.
doc/rst/language/spec/domains.rst
Outdated
| The type of the resulting domain is the same as the original domain, | ||
| with the ``strides`` parameter adjusted to accept all the strides | ||
| that are accepted by the ``strides`` parameters of the resulting | ||
| domain's ranges. |
There was a problem hiding this comment.
If you make a change like the one I suggested above, you'll want to replicate that language here.
doc/rst/language/spec/ranges.rst
Outdated
| For example: | ||
|
|
||
| - If the base range has ``strides=strideKind.one`` and the step is | ||
| the literal ``-2``, the result has ``strides=strideKind.positive``. |
There was a problem hiding this comment.
I started with one, so positive is definitely an improvement. :)
Signed-off-by: Vassily Litvinov <vasslitvinov@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the Ranges and Domains and Coercions chapters of the spec and the comments in the ranges and other primers for the change
range.stridable-->strides: strideKindin #22441, with follow-ons #22486 and #22508.Also remove the remaining occurrences of
BoundedRangeTypefrom the spec and primers -- it is deprecated as of #22059.Remove the
constreturn and yield intent in the Procedures, Iterators, and Tuples sections of the spec -- it is unstable as of #22515. I did not see any need to update the primers for this change.While there, I did some rephrasing and restructuring of the text for better readability or precision.
Testing: visual examination of the generated docs; a standard paratest.
Post-merge: update the Chapel Evolution document.