doc(string): add more design details #2203
Merged
Conversation
This file contains hidden or 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
Consider using consistent terminology for indicesCategory
Test example for View conversion could be more completeCategory test "view conversion" {
fn process_text(text : View) -> Int {
text.length()
}
let str = "Hello World"
let view = str.charcodes(start=0, end=5)
assert(process_text(str) == 11)
assert(process_text(view) == 5)
}
**Reasoning**
Test cases should verify the expected behavior. The current example shows the API usage but doesn't verify the results, making it less useful as a documentation example.
</details>
<details>
<summary> Missing important detail about View lifetime </summary>
**Category**
Correctness
**Code Snippet**
- **Performance**: Views are more performant than creating new String instances
when working with substrings. They avoid string copying and memory allocation
by maintaining references to the original string
**Recommendation**
Add explicit documentation about View lifetime and its dependency on the original String:
'Views maintain a reference to the original String. Therefore, the original String must outlive all its Views.'
**Reasoning**
When dealing with references, it's crucial to document lifetime constraints to prevent potential use-after-free bugs. This is especially important in a systems programming language.
</details> |
Pull Request Test Coverage Report for Build 18Details
💛 - Coveralls |
583f054 to
ed569bc
Compare
7ce217f to
ad79f9c
Compare
ad79f9c to
4369c1a
Compare
…rning while `moon check --deny-warn` fails with Error(warning)
4369c1a to
4aefd50
Compare
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.
Should we rename it to README.mbt.md so that it more visible to the public? @bobzhang