Skip to content

Commit

Permalink
doc: overhaul std/misc/shared documentation
Browse files Browse the repository at this point in the history
also, adding deprecation note, since gambit 4.9.1 added similar support to the
regular equal? predicate
  • Loading branch information
dwdv committed May 22, 2019
1 parent ab0c3e8 commit 9ee66d1
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions doc/reference/misc.md
Original file line number Diff line number Diff line change
Expand Up @@ -3935,15 +3935,19 @@ Please document me!
:::

### equal-shared?
::: tip usage
```
(equal-shared? ...)
```
:::
``` scheme
(equal-shared? a b) -> boolean
Please document me!
a, b := structures to check
```

Checks whether *a* and *b*, two potentially recursive, cyclic or otherwise
infinite shared structures, e.g. trees or graphs, are equal.

::: warning Deprecation note:
Gambit 4.9.1 (released 2018-11-16) added similar support for handling shared
structures with `equal?`, superseding `equal-shared?`.
:::

## Shuffling
::: tip To use the bindings from this module:
Expand Down

0 comments on commit 9ee66d1

Please sign in to comment.