Skip to content

Commit cda4737

Browse files
committed
clarify that syncheck:find-source-object's result needs to make sense with equal?
1 parent 6868b16 commit cda4737

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

drracket-tool-doc/scribblings/drracket-tools/drracket-tools.scrbl

+7-3
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,13 @@ in order to make the results be platform independent.
140140
annotations are those in the original file and this is a syntax object
141141
introduced by a macro and thus has a source location from some other file).
142142

143-
Otherwise, it should return some (non-@racket[#f])
144-
value that will then be passed to one of the other methods below as
145-
a @racket[_source-obj] argument.
143+
Otherwise, it should return some (non-@racket[#f]) value
144+
that will then be passed to one of the other methods below
145+
as a @racket[_source-obj] argument. Also, the result of this
146+
method is used as a key in an @racket[equal?]-based
147+
@tech[#:doc '(lib "scribblings/reference/reference.scrbl")]{hash},
148+
so two source objects should refer to the same original source
149+
if and only if they are @racket[equal?].
146150
}
147151

148152
@defmethod[(syncheck:add-text-type [source-obj (not/c #f)]

0 commit comments

Comments
 (0)