From 71acc6c544de6cd528243aaf8725c666cb9428b4 Mon Sep 17 00:00:00 2001
From: Jeong Yunwon <jeong@youknowone.org>
Date: Mon, 18 Apr 2022 03:43:44 +0900
Subject: [PATCH] Documentation for the names

---
 vm/src/pyobjectrc.rs | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/vm/src/pyobjectrc.rs b/vm/src/pyobjectrc.rs
index 334aefc04..337a85a86 100644
--- a/vm/src/pyobjectrc.rs
+++ b/vm/src/pyobjectrc.rs
@@ -1,3 +1,16 @@
+//! Essential types for object models
+//!
+//! +-------------------------+--------------+---------------+
+//! |       Management        |    Typed     |    Untyped    |
+//! +-------------------------+--------------+---------------+
+//! | Interpreter-independent | Py<T>        | PyObject      |
+//! | Reference-counted       | PyRef<T>     | PyObjectRef   |
+//! | Weak                    | PyWeakRef<T> | PyRef<PyWeak> |
+//! +-------------------------+--------------+---------------+
+//!
+//! PyRef<PyWeak> may looking like to be called as PyObjectWeak by the rule,
+//! but not to do to remember it is a PyRef object.
+
 use crate::common::atomic::{OncePtr, PyAtomic, Radium};
 use crate::common::linked_list::{Link, LinkedList, Pointers};
 use crate::common::lock::{PyMutex, PyMutexGuard, PyRwLock};