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

[doc]: Clarify end behavior in vector-sort[!] when set to #f #5114

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

NoahStoryM
Copy link
Contributor

Checklist
  • Bugfix
  • Feature
  • tests included
  • documentation

Description of change

This PR updates the vector-sort and vector-sort! documentation to clarify the behavior of the end and key.

@mz-examples[#:eval vec-eval
(define v1 (vector 4 3 2 1))
(vector-sort v1 <)
v1
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the point of having v1 after (vector-sort v1 <) originally is to show whether vector-sort has side-effect. So we should either move v1 to the end of the sequences of (vector-sort v1 ....). Alternatively, if you don't think it's worth the effort to do the demonstratation, then we should just delete the lone v1 / v2.

@shhyou shhyou added the documentation Issues related to README and documentation (typos, rewording, new docs, etc) label Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues related to README and documentation (typos, rewording, new docs, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants