starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-03-31 06:03:11 +02:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Improve documentation about Set/Map ordering (#944)

Browse Source 
The language reference and stdlib are both slightly incorrect;
maps and sets are ordered when iterated on, but unordered in terms of
equality.
This commit is contained in:
Daniel Chao
2025-02-12 06:43:51 -08:00
committed by GitHub
parent 7ed710c226
commit 7c3f8ad261
2 changed files with 41 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
stdlib/base.pkl
View File

@@ -1,5 +1,5 @@
//===----------------------------------------------------------------------===//
// Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.
// Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -3040,7 +3040,11 @@ external class List<out Element> extends Collection<Element> {
/// ```
external const function Set<Element>(elements: VarArgs<Element>): Set<Element>
/// An unordered collection of unique elements.
/// A collection of unique elements.
///
/// Sets retain the order of elements when constructed, which affects the how they are iterated
/// over.
/// However, ordering does not affect equality between two sets.
///
/// The following operators are supported for sets:
/// ```
@@ -3174,7 +3178,11 @@ external class Set<out Element> extends Collection<Element> {
/// ```
external const function Map<Key, Value>(keysAndValues: VarArgs<Key|Value>): Map<Key, Value>
/// An unordered mapping from keys to values.
/// A mapping from keys to values.
///
/// Maps retain the order of entries when constructed, which affects the how they are iterated
/// over.
/// However, ordering of entries does not affect equality between two maps.
///
/// The following operators are supported for maps:
/// ```