doc: add docstrings and examples for String functions
#4332
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
toolchain-available
leanprover-community-mathlib4-bot
added a commit
to leanprover-community/batteries
that referenced
this pull request
Jun 3, 2024
leanprover-community-mathlib4-bot
added a commit
to leanprover-community/mathlib4
that referenced
this pull request
Jun 3, 2024
leanprover-community-mathlib4-bot
added
breaks-mathlib
|
Mathlib CI status (docs):
|
Add docstrings, usage examples, and doctests for `String.get'`, `String.next'`, `String.posOf`, `String.revPosOf`.
austinletson
force-pushed
the
string-docs-3
branch
from
d9585bb
to
29adfc1
Compare
semorrison
reviewed
Jun 4, 2024
semorrison
reviewed
Jun 4, 2024
src/Init/Data/String/Basic.lean
Outdated
Comment on lines
266
to
268
| Given `def abc := "abc"` and `def lean := "L∃∀N"`, | ||
| * `abc.get' 0 (by decide) = 'a'` | ||
| * `lean.get' (0 |> lean.next |> lean.next) (by decide) = '∀'` |
There was a problem hiding this comment.
May clearer without the defs, and just inlining the strings?
There was a problem hiding this comment.
I updated the single "abc" case. I agree this is more apparent.
I have streamlined the repetitive examples by replacing the "Given, def..." line with a let statement in the bullet:
`let lean := "L∃∀N"; lean.get' (0 |> lean.next |> lean.next) (by decide) = '∀'`It seems off to me to inline the string in the repetitive cases:
`"L∃∀N".get' (0 |> "L∃∀N".next |> "L∃∀N".next) (by decide) = '∀'`.However, please let me know if you still prefer the inlining in the repetitive cases, and I will update the examples accordingly.
|
Otherwise, looks good. |
semorrison
added
awaiting-author
|
awaiting-review |
github-actions
bot
added
awaiting-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add docstrings, usage examples, and doctests for
String.get',String.next',String.posOf,String.revPosOf.