Improved documentation. #258
Open
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
- `FromPrimitive` functions now refer to implementor for details.
frewsxcv
reviewed
May 20, 2023
| @@ -16,39 +16,39 @@ use core::{u128, u16, u32, u64, u8, usize}; | |||
| /// even a large `f64` saturating to `f32` infinity. | |||
| pub trait ToPrimitive { | |||
| /// Converts the value of `self` to an `isize`. If the value cannot be | |||
| /// represented by an `isize`, then `None` is returned. | |||
There was a problem hiding this comment.
How does removing the word "then" change the meaning of the sentence?
There was a problem hiding this comment.
It doesn't change the meaning. Seeing all those "then" removals listed, you may think it's something central. But I just changed it at one place for the more common phrasing, and then saw that the sentence was copied elsewhere, so I had to change these occurrences also.
The central piece of the PR is the addition of the lines that say See `Self` type or trait implementation for details. But since this is just a casual doc comment improvement, I don't think the additional "then" removals are a problem.
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.
FromPrimitivefunctions now refer to implementor for details.See rust-num/num-rational#113.