Skip to content

Commit

Permalink
doc: update doc for HammingDistance
Browse files Browse the repository at this point in the history
  • Loading branch information
duke-git committed Mar 3, 2024
1 parent 0b5e884 commit aabfcb7
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 4 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1621,7 +1621,8 @@ import "github.com/duke-git/lancet/v2/strutil"
[[play](https://go.dev/play/p/HzLC9vsTwkf)]
- **<big>SubInBetween</big>** : return substring between the start and end position(excluded) of source string.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/strutil.md#SubInBetween)]

- **<big>HammingDistance</big>** : calculates the Hamming distance between two strings.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/strutil.md#HammingDistance)]

<h3 id="system"> 22. System package contain some functions about os, runtime, shell command. &nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">index</a></h3>

Expand Down
3 changes: 2 additions & 1 deletion README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -1620,7 +1620,8 @@ import "github.com/duke-git/lancet/v2/strutil"
[[play](https://go.dev/play/p/HzLC9vsTwkf)]
- **<big>SubInBetween</big>** : 获取字符串中指定的起始字符串start和终止字符串end直接的子字符串。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/strutil.md#SubInBetween)]

- **<big>HammingDistance</big>** : 计算两个字符串之间的汉明距离。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/strutil.md#HammingDistance)]

<h3 id="system"> 22. system 包含 os, runtime, shell command 的相关函数。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>

Expand Down
2 changes: 1 addition & 1 deletion docs/api/packages/strutil.md
Original file line number Diff line number Diff line change
Expand Up @@ -1500,7 +1500,7 @@ func main() {

### <span id="HammingDistance">HammingDistance</span>

<p>TBD</p>
<p>计算两个字符串之间的汉明距离。汉明距离是指对应符号不同的位置数。</p>

<b>函数签名:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/en/api/packages/strutil.md
Original file line number Diff line number Diff line change
Expand Up @@ -1502,7 +1502,7 @@ func main() {

### <span id="HammingDistance">HammingDistance</span>

<p>HammingDistance calculates the Hamming distance between two strings. The Hamming distance is the number of positions at which the corresponding symbols are different</p>
<p>HammingDistance calculates the Hamming distance between two strings. The Hamming distance is the number of positions at which the corresponding symbols are different.</p>

<b>Signature:</b>

Expand Down

0 comments on commit aabfcb7

Please sign in to comment.