Skip to content

Commit

Permalink
Merge pull request #473 from cunarist/improve-error-docs-readability
Browse files Browse the repository at this point in the history
Improve readabillity of error handling docs
  • Loading branch information
temeddix authored Oct 26, 2024
2 parents 1845db9 + 4956822 commit f270370
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion documentation/docs/detailed-techniques.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ We've covered how to pass signals[^1] between Dart and Rust in the previous tuto

- **Field `binary`:** This is a field designed to handle large binary data, potentially up to a few gigabytes. You can send any kind of binary data you wish, such as a high-resolution image or file data. This field carries empty `Uint8List` or `Vec<u8>` if the message is not marked as binary signal.

It's important to note that creating a Protobuf `message` larger than a few megabytes is not recommended. For large data, split them into multiple signals, or use the `binary` field.[^2]
It's important to note that creating a Protobuf `message` larger than a few megabytes is not recommended. For large data, split them into multiple signals, or use the `binary` field instead.[^2]

[^1]: Rinf relies solely on native FFI for communication, avoiding the use of web protocols or hidden threads. The goal is to minimize performance overhead as much as possible.

Expand Down
6 changes: 3 additions & 3 deletions documentation/docs/error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Effective error handling is crucial in applications to ensure a smooth user experience and predictable application behavior.

Rinf expects developers to use Flutter exclusively for the UI layer while keeping all business logic in Rust. This approach encourages handling errors and logging directly in Rust without crossing the language boundary.
Rinf expects developers to use Flutter exclusively for the UI layer while keeping all business logic in Rust. This approach encourages handling errors and logging directly in Rust without crossing the language boundary.[^1]

Rinf doesn't automatically handle Rust errors for you. By explicitly managing these errors, you can make your app clearer and more robust. Rinf was designed to be a reliable framework without excessive abstractions or implicit behaviors.
[^1]: Rinf doesn't automatically handle Rust errors for you. By explicitly managing these errors, you can make your app clearer and more robust. Rinf was designed to be a reliable framework without excessive abstractions or implicit behaviors.

However, there are recommended practices for managing errors in real-world applications.
There are recommended practices for managing errors in real-world applications.

## 🌪️ No Panicking

Expand Down

0 comments on commit f270370

Please sign in to comment.