Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the Sort module an official standard module #25586

Merged
merged 10 commits into from
Jul 22, 2024

Conversation

jabraham17
Copy link
Member

@jabraham17 jabraham17 commented Jul 16, 2024

Makes the Sort module an official standard module. This should not be a user facing change as package modules and standard modules mostly differ in name only. However, there are changes to the online documentation. This PR adds a blank Sort page to the old location so that there will be no dead doc links as a result of this change.

Docs page:
Screenshot 2024-07-16 at 9 21 42 AM

Resolves #25083

Testing

  • built and check docs
  • paratest with/without comm

[Reviewed by @ShreyasKhandekar]

Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Copy link
Contributor

@ShreyasKhandekar ShreyasKhandekar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Just some minor feedback.

doc/rst/meta/modules/packages/Sort.rst Outdated Show resolved Hide resolved
doc/rst/meta/modules/packages/Sort.rst Outdated Show resolved Hide resolved
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
@jabraham17 jabraham17 merged commit 06ed102 into chapel-lang:main Jul 22, 2024
7 checks passed
@jabraham17 jabraham17 deleted the move-sort branch July 22, 2024 15:24
jabraham17 added a commit that referenced this pull request Aug 1, 2024
Moves all of the Sort tests from their old location in
`test/library/packages` to `test/library/standard`.

Followup to #25586

- [x] Tested with a full paratest with/without comm

[Reviewed by @ShreyasKhandekar]
ShreyasKhandekar added a commit to ShreyasKhandekar/chapel that referenced this pull request Sep 18, 2024
Update the sort module documentation based on the work done in the sort module stabilization subteam.

On a high level
- Added a short intro with a few examples of using `proc sort`, before this change it was a bit wierd to just see Comparators as the first thing in the sort module docs.
- Edited the comparators section to mention the new prescribed way to create and use custom comparators using the newly created interfaces.
- Went over the rest of the doc to update other things that have changed like argument names

This includes work done in the following PRs:

    chapel-lang#25863
    chapel-lang#25852
    chapel-lang#25821
    chapel-lang#25817
    chapel-lang#25813
    chapel-lang#25807
    chapel-lang#25705
    chapel-lang#25703
    chapel-lang#25699
    chapel-lang#25698
    chapel-lang#25586

Signed-off-by: Shreyas Khandekar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make the Sort module a proper standard module
2 participants