From a700b7f7ef2a0e90175ea7af923fd40775fd98a7 Mon Sep 17 00:00:00 2001
From: Jeremy <51220084+jeremy-rifkin@users.noreply.github.com>
Date: Tue, 27 Feb 2024 22:53:16 -0600
Subject: [PATCH] Update documentation for stacktrace_frames

---
 README.md     | 3 ++-
 docs/c-api.md | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d21b174..1155bbe 100644
--- a/README.md
+++ b/README.md
@@ -159,7 +159,8 @@ namespace cpptrace {
     using frame_ptr = std::uintptr_t;
 
     struct stacktrace_frame {
-        frame_ptr address;
+        frame_ptr raw_address; // address in memory
+        frame_ptr object_address; // address in the object file
         // nullable<T> represents a nullable integer. More docs later.
         nullable<std::uint32_t> line;
         nullable<std::uint32_t> column;
diff --git a/docs/c-api.md b/docs/c-api.md
index b079f62..851bf6d 100644
--- a/docs/c-api.md
+++ b/docs/c-api.md
@@ -34,7 +34,8 @@ the parameters.
 typedef struct ctrace_stacktrace ctrace_stacktrace;
 
 struct ctrace_stacktrace_frame {
-    ctrace_frame_ptr address;
+    ctrace_frame_ptr raw_address;
+    ctrace_frame_ptr object_address;
     uint32_t line;
     uint32_t column;
     const char* filename;