From cc4a6fe411d58316672252d3d13b8df6eede987e Mon Sep 17 00:00:00 2001 From: Jason Smith Date: Sat, 14 Apr 2018 16:39:52 -0400 Subject: [PATCH] Just adding some programmer notes. --- src/raw.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/raw.rs b/src/raw.rs index 93929ec..494bed5 100644 --- a/src/raw.rs +++ b/src/raw.rs @@ -1,3 +1,12 @@ +//! These types are here to be used in bindings only. Other conversion +//! traits, either from the spellbook or standard library are to be used +//! at all other times. These were determined to be used at the binding +//! level to make sure that it was understood that you are getting and +//! using a value from a non rust source. These traits are only there +//! to help with understanding the code and to remind the programmer +//! where values are coming from. + + /// Some times there are types that need to return a platform specific /// data type that can be used by the platform specific functions. This /// type creates a path to easily get that data.