improved documentation for build_int_mul, build_int_sub, build_float_sub and build_float_mul #535
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
…sub, build_float_mul
TheDan64
reviewed
Sep 19, 2024
|
|
||
| ///creates integer subtraction given `lhs` and `rhs`. It returns either an `IntValue` or `BuilderError` | ||
| ///```rust,no_run | ||
| ///fn int_subtraction(lhs: i8, rhs: i8) -> i8{ |
There was a problem hiding this comment.
nit: can you please fix spacing after the slashes, and capitalize the C in creates
|
|
||
| ///creates float subtraction given `lhs` and `rhs` as FloatValue. It returns either an `FloatValue` or `BuilderError` | ||
| ///```rust,no_run | ||
| ///fn float_subtraction(lhs: f16, rhs: f16) -> f16{ |
| ///creates int multiplication given `lhs` and `rhs` as IntValue. It returns either an | ||
| ///`IntValue` or `BuilderError` | ||
| ///```rust,no_run | ||
| ///fn int_mul(lhs: i8, rhs: i8) -> i8{ |
| ///creates float multiplication | ||
| /// given `lhs` and `rhs` as FloatValue. It returns either an `FloatValue` or `BuilderError` | ||
| ///```rust,no_run | ||
| ///fn float_subtraction(lhs: f16, rhs: f16) -> f16{ |
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.
Description
Improved documentations for functions in the title in builder.rs file with examples.
How This Has Been Tested
I have not tested these changes since it's just a slight documentation change and I edited no code
Checklist
##Warning
This is my first ever pull request so it may not be the best.