Added doc for more string-dict methods #27
Conversation
fold-keys each-key; and for mutable-string-dict methods: merge-now keys-list-now map-keys-now fold-keys-now each-key-now.
src/trove/string-dict.scrbl
Outdated
| ] | ||
|
|
||
| Returns a new immutable string-dict that has the keys of both | ||
| the original string-dict and the @pyret{other} string-dict. Choose a key's |
There was a problem hiding this comment.
I wouldn't use the verb "choose" here, since that sounds to me like the programmer has a choice. I'd reword this to "In cases where both input dictionaries have the same key, the resulting value comes from the @pyret{other} string-dict."
src/trove/string-dict.scrbl
Outdated
| sd3 is [string-dict: "a", 10, "b", 6, "c", 4] | ||
| sd4 = sd2.merge(sd1) | ||
| sd4 is [string-dict: "a", 5, "b", 6, "c", 4] | ||
| sd2.merge(sd1).merge(sd1) is sd2.merge(sd1) |
There was a problem hiding this comment.
# merging the same dictionary twice has no additional effect
| sd3 = sd1.merge(sd2) | ||
| sd3 is [string-dict: "a", 10, "b", 6, "c", 4] | ||
| sd4 = sd2.merge(sd1) | ||
| sd4 is [string-dict: "a", 5, "b", 6, "c", 4] |
src/trove/string-dict.scrbl
Outdated
| #:return (L-of S) | ||
| ] | ||
|
|
||
| Returns the list of keys in the immutable string-dict, in some order. |
src/trove/string-dict.scrbl
Outdated
| @examples{ | ||
| check: | ||
| sd2 = [string-dict: "a", 10, "b", 6] | ||
| sd2.keys-list() is [list: "a", "b"] |
There was a problem hiding this comment.
If the order is unspecified, then this test might fail. Either add a .sort() or make it into a set or something...
src/trove/string-dict.scrbl
Outdated
| ] | ||
|
|
||
| Modifies the mutable string-dict to include the keys from the @pyret{other} | ||
| mutable-string-dict. Choose a key's value to be the one it has in the @pyret{other} |
src/trove/string-dict.scrbl
Outdated
| #:return (L-of S) | ||
| ] | ||
|
|
||
| Returns the list of keys in the mutable string-dict, in some order. |
src/trove/string-dict.scrbl
Outdated
| #:return (L-of "b") | ||
| ] | ||
|
|
||
| Modify the mutable string-dict so that each key is now |
There was a problem hiding this comment.
No -- this returns a List<b>, and the description sounds like it returns a MSD.
src/trove/string-dict.scrbl
Outdated
|
|
||
| @examples{ | ||
| fun one-of(ans, elts): | ||
| is-some(for find(elt from elts): |
| #:return No | ||
| ] | ||
|
|
||
| Calls the function @pyret{f} on each key in the mutable string-dict, |
There was a problem hiding this comment.
Thanks -- made your suggested changes. When having the description of each-key refer to map-keys, I tried using @pyret-id{map-keys} rather than @pyret{map-keys} to make it a hyperlink, but it doesn't seem to work. Is there a Pyret scribble quickref that will show how to ensure that @pyret-id{...} does link.
There was a problem hiding this comment.
Use @pyret-method["StringDict"]{each-key} to link to the each-key method of the StringDict data type.
src/trove/string-dict.scrbl
Outdated
| check: | ||
| sd2 = [string-dict: "a", 10, "b", 6] | ||
| sd2.map-keys(lam(x): string-append(x, x) end) is%(one-of) | ||
| sd2.map-keys(lam(x): string-append(x, x) end) is%(lam(lft, rt): rt.member(lft) end) |
There was a problem hiding this comment.
This is complicated-looking. Why not use .sort() like you did on line 273 above for keys-list?
src/trove/string-dict.scrbl
Outdated
| check: | ||
| msd2 = [mutable-string-dict: "a", 10, "b", 6] | ||
| msd2.map-keys-now(lam(x): string-append(x, x) end) is%(one-of) | ||
| msd2.map-keys-now(lam(x): string-append(x, x) end) is%(lam(lft, rt): rt.member(lft) end) |
|
@ds26gte this PR seems awfully close to being mergeable. Any chance you can put an hour towards getting it across the finish line? |
This addresses brownplt/pyret-lang#1245. It adds documentation for the immutable string-dict methods
{merge, keys-list, map-keys, fold-keys, each-key}and the mutable-string-dict methogs{merge-now, keys-list-now, map-keys-now, fold-keys-now, each-key-now}.