aparoksha/levenshtein-transformations
1
0
Fork 1
Code Issues Pull Requests Actions Releases 2 Activity

Update documentation
All checks were successful
Deploy Docs / publish (push) Successful in 12s
Details

Browse Source
This commit is contained in:
david-swift 2024-10-07 09:58:31 +02:00
parent 9996fa23af
commit 75a4b9036e
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Sources/LevenshteinTransformations/LevenshteinTransformations.docc/GettingStarted.md
View File

@ -42,7 +42,7 @@ Insert '10' at position 4
``` ```
#### Run Functions for the Steps #### Run Functions for the Steps
Directly run functions for the `replace`, `delete` and `insert` transformations using the ``Swift/Array/transform(to:functions:)`` (for strings: ``Swift/String/transform(to:functions:)``) function. Directly run functions for the `replace`, `delete` and `insert` transformations using the ``Swift/Array/transform(to:functions:)-2wzm8`` (for strings: ``Swift/String/transform(to:functions:)-3b6nc``) function.
```swift ```swift
var modified = source var modified = source
@ -61,12 +61,15 @@ print(modified == target)
``` ```
This example outputs `true`. This example outputs `true`.
The transform functions are available in an asynchronous version: ``Swift/Array/transform(to:functions:)-756uw`` for arrays and ``Swift/String/transform(to:functions:)-46is`` for strings.
### Arrays with Identifiable Elements ### Arrays with Identifiable Elements
The same functions are available for arrays with identifiable elements, but they are named differently to avoid conflicts: The same functions are available for arrays with identifiable elements, but they are named differently to avoid conflicts:
- ``Swift/Array/identifiableLevenshteinDistance(to:)`` - ``Swift/Array/identifiableLevenshteinDistance(to:)``
- ``Swift/Array/identifiableGetTransformations(to:)`` - ``Swift/Array/identifiableGetTransformations(to:)``
- ``Swift/Array/identifiableTransform(to:functions:)`` - ``Swift/Array/identifiableTransform(to:functions:)-2500q``
- ``Swift/Array/identifiableTransform(to:functions:)-1du5b``
## Development ## Development
_Levenshtein Transformations_ is an open source project. Visit the [Git repository][1] for bug reports, feature requests, pull requests and more information. _Levenshtein Transformations_ is an open source project. Visit the [Git repository][1] for bug reports, feature requests, pull requests and more information.