diff --git a/website/docs/api/goldparse.md b/website/docs/api/goldparse.md index 2419a8e55..23575038c 100644 --- a/website/docs/api/goldparse.md +++ b/website/docs/api/goldparse.md @@ -81,6 +81,15 @@ Convert a list of Doc objects into the Calculate alignment tables between two tokenizations, using the Levenshtein algorithm. The alignment is case-insensitive. + + +The current implementation of the alignment algorithm assumes that both +tokenizations add up to the same string. For example, you'll be able to align +`["I", "'", "m"]` and `["I", "'m"]`, which both add up to `"I'm"`, but not +`["I", "'m"]` and `["I", "am"]`. + + + > #### Example > > ```python