leanprover / lean4

Lean 4 programming language and theorem prover
https://lean-lang.org
Apache License 2.0
3.88k stars 329 forks source link

doc: add docstrings and examples for String functions #4166

Closed austinletson closed 1 week ago

austinletson commented 2 weeks ago

Add docstrings, usage examples, and doc tests for String.prev, .front, .back, .atEnd.

Improve docstring examples for String.next based on discussion examples for String.prev.

leanprover-community-mathlib4-bot commented 2 weeks ago

Mathlib CI status (docs):

austinletson commented 2 weeks ago

@semorrison Thank you for adding the tests! After all the threads are resolved, I will go back and update the test to reflect the final docstrings.

austinletson commented 2 weeks ago

I updated the tests based on the updated examples.

Let me know if there is any additional areas for improvement. If not, this should be ready to go!

austinletson commented 1 week ago

Thanks, David! I hope you had a nice holiday!