mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-02-15 07:43:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

strutils: improve doc comments for replace funcs (#17427)

Browse Source 
This commit fixes mispellings of "occurrence" introduced by:
- 76a3b350ce (#17337)
- 8e8bea9044 (#17339)
and adds the same "every occurrence of" in the `replaceWord` func.

Other changes:
- Prefer "replace with" to "replace by".
- Be more consistent with "the" - prefer "of the character" given that
  we wrote "by the character".
- Try to be more consistent with writing the types - add
  "the string `sub`" given that we wrote "the character `sub`".
This commit is contained in:
ee7
2021-03-20 13:22:50 +01:00
committed by GitHub
parent 9997b42c35
commit b70e33f5bb
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
lib/pure/strutils.nim
View File

@@ -2037,7 +2037,7 @@ func contains*(s: string, chars: set[char]): bool =
func replace*(s, sub: string, by = ""): string {.rtl, func replace*(s, sub: string, by = ""): string {.rtl,
extern: "nsuReplaceStr".} = extern: "nsuReplaceStr".} =
## Replaces every occurence of `sub` in `s` by the string `by`. ## Replaces every occurrence of the string `sub` in `s` with the string `by`.
## ##
## See also: ## See also:
## * `find func<#find,string,string,Natural,int>`_ ## * `find func<#find,string,string,Natural,int>`_
@@ -2079,7 +2079,8 @@ func replace*(s, sub: string, by = ""): string {.rtl,
func replace*(s: string, sub, by: char): string {.rtl, func replace*(s: string, sub, by: char): string {.rtl,
extern: "nsuReplaceChar".} = extern: "nsuReplaceChar".} =
## Replaces every occurence of character `sub` in `s` by the character `by`. ## Replaces every occurrence of the character `sub` in `s` with the character
## `by`.
## ##
## Optimized version of `replace <#replace,string,string,string>`_ for ## Optimized version of `replace <#replace,string,string,string>`_ for
## characters. ## characters.
@@ -2097,7 +2098,7 @@ func replace*(s: string, sub, by: char): string {.rtl,
func replaceWord*(s, sub: string, by = ""): string {.rtl, func replaceWord*(s, sub: string, by = ""): string {.rtl,
extern: "nsuReplaceWord".} = extern: "nsuReplaceWord".} =
## Replaces `sub` in `s` by the string `by`. ## Replaces every occurrence of the string `sub` in `s` with the string `by`.
## ##
## Each occurrence of `sub` has to be surrounded by word boundaries ## Each occurrence of `sub` has to be surrounded by word boundaries
## (comparable to `\b` in regular expressions), otherwise it is not ## (comparable to `\b` in regular expressions), otherwise it is not