From 938e9506996df13b3f08419854aa73c7d24f2d44 Mon Sep 17 00:00:00 2001
From: Mason Reed <mason@vector35.com>
Date: Fri, 13 Mar 2026 12:19:41 -0700
Subject: [Rust] Misc docs

---
 rust/src/platform.rs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'rust/src/platform.rs')

diff --git a/rust/src/platform.rs b/rust/src/platform.rs
index 46129b81..bf135fae 100644
--- a/rust/src/platform.rs
+++ b/rust/src/platform.rs
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! Contains all information related to the execution environment of the binary, mainly the calling conventions used
+//! A [`Platform`] models the information related to the execution environment of the binary.
 
 use crate::{
     architecture::{Architecture, CoreArchitecture},
@@ -29,6 +29,8 @@ use std::fmt::Debug;
 use std::ptr::NonNull;
 use std::{borrow::Borrow, ffi, ptr};
 
+/// A platform describes the target [`CoreArchitecture`] and platform-specific information such as
+/// the calling conventions and generic types (think `HRESULT` on Windows).
 #[derive(PartialEq, Eq, Hash)]
 pub struct Platform {
     pub(crate) handle: *mut BNPlatform,
-- 
cgit v1.3.1