[Chapel Merge] Tidy up range docs

Notifications Commits
1

Branch: refs/heads/main
Revision: 1b5d5a5
Author: bradcray
Link: Unavailable
Log Message:

Merge pull request #20616 from bradcray/range-docs-tidying

Tidy up range docs

[reviewed by @bmcdonald3 — thanks!]

While reviewing my the range docs after my changes to its behavior
last night, I found some pre-existing bugs that needed fixing,
that the operators were now being generated by chpldoc, and some
other opportunities for cleanup. Summarizing, they were:

  • the expected output from the alignedLow/High docs wasn't printing
    (and hadn't been in previous releases either)

  • the signatures on the param/type queries in the spec used illegal
    syntax (though now they fall prey to the poor spacing when
    rendered by Sphinx on Chrome.

  • I squashed the chpldocumentation of the operators because they're
    already described in the text of the spec, which does a better job
    of it. That said, going forward, I think we'd like to find a way to
    integrate operator signatures into these sections of the spec so
    that people can see what the overloads are. Not today's task though.

  • I tried to clarify some wordings and descriptions.

  • removed the "more descriptive" clause that I'd applied to the
    alignedLow/High queries yesterday because it sounded like more of
    a value judgement or preference than I'd intended.

  • I more uniformly set true and false off using code
    formatting.

  • I more uniformly started entries with "Returns" rather than "Return"

  • I more uniformly ended descriptions with periods

    Modified Files:
    M doc/rst/language/spec/ranges.rst
    M modules/internal/ChapelRange.chpl
    M test/deprecated/alignedBoundsByDefault.good

    Compare: Comparing 0dcc87afa902...1b5d5a514030 · chapel-lang/chapel · GitHub