Skip to content

Docs: clarify that sort and sort_natural are stable #2111

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.

Sign up for GitHub

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

Open
Hashim1999164 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: clarify that sort and sort_natural are stable #2111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions lib/liquid/standardfilters.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,9 @@ def join(input, glue = ' ')
# @liquid_category array
# @liquid_summary
# Sorts the items in an array in case-sensitive alphabetical, or numerical, order.
# @liquid_description
# The sort is stable: items that compare as equal keep their original relative order.
# Pass an optional property name to sort objects by that property, for example `array | sort: "name"`.
# @liquid_syntax array | sort
# @liquid_return [array[untyped]]
def sort(input, property = nil)
Expand All @@ -421,6 +424,8 @@ def sort(input, property = nil)
# @liquid_summary
# Sorts the items in an array in case-insensitive alphabetical order.
# @liquid_description
# The sort is stable: items that compare as equal keep their original relative order.
#
# > Caution:
# > You shouldn't use the `sort_natural` filter to sort numerical values. When comparing items an array, each item is converted to a
# > string, so sorting on numerical values can lead to unexpected results.
Expand Down
Loading