@@ -12,7 +12,7 @@ pub fn class_doc_link(class: &GodotClass) -> String {
12
12
13
13
pub fn official_doc_url ( class : & GodotClass ) -> String {
14
14
format ! (
15
- "https://godot.readthedocs.io/en/latest /classes/class_{lower_case}.html" ,
15
+ "https://godot.readthedocs.io/en/stable /classes/class_{lower_case}.html" ,
16
16
lower_case = class. name. to_lowercase( ) ,
17
17
)
18
18
}
@@ -31,31 +31,31 @@ pub fn generate_module_doc(class: &GodotClass) -> TokenStream {
31
31
pub fn generate_class_documentation ( api : & Api , class : & GodotClass ) -> TokenStream {
32
32
let has_parent = !class. base_class . is_empty ( ) ;
33
33
let singleton_str = if class. singleton { "singleton " } else { "" } ;
34
- let ownership_type = if class. is_refcounted ( ) {
35
- "reference counted"
34
+ let memory_type = if class. is_refcounted ( ) {
35
+ "reference- counted"
36
36
} else {
37
- "unsafe "
37
+ "manually managed "
38
38
} ;
39
39
40
40
let mut summary_doc = if & class. name == "Reference" {
41
41
"Base class of all reference-counted types. Inherits `Object`." . into ( )
42
42
} else if & class. name == "Object" {
43
- "The base class of most Godot classes ." . into ( )
43
+ "The base class of all classes in the Godot hierarchy ." . into ( )
44
44
} else if has_parent {
45
45
format ! (
46
- "`{api_type} {singleton}class {name}` inherits `{base_class}` ({ownership_type })." ,
46
+ "`{api_type} {singleton}class {name}` inherits `{base_class}` ({memory_type })." ,
47
47
api_type = class. api_type,
48
48
name = class. name,
49
49
base_class = class. base_class,
50
- ownership_type = ownership_type ,
50
+ memory_type = memory_type ,
51
51
singleton = singleton_str,
52
52
)
53
53
} else {
54
54
format ! (
55
- "`{api_type} {singleton}class {name}` ({ownership_type })" ,
55
+ "`{api_type} {singleton}class {name}` ({memory_type })" ,
56
56
api_type = class. api_type,
57
57
name = class. name,
58
- ownership_type = ownership_type ,
58
+ memory_type = memory_type ,
59
59
singleton = singleton_str,
60
60
)
61
61
} ;
@@ -79,7 +79,7 @@ The lifetime of this object is automatically managed through reference counting.
79
79
format ! (
80
80
r#"## Memory management
81
81
82
- Non reference counted objects such as the ones of this type are usually owned by the engine.
82
+ Non- reference- counted objects, such as the ones of this type, are usually owned by the engine.
83
83
84
84
`{name}` is a reference-only type. Persistent references can
85
85
only exist in the unsafe `Ref<{name}>` form.
@@ -126,7 +126,7 @@ This class is used to interact with Godot's editor."#
126
126
let safety_doc = r#"
127
127
## Safety
128
128
129
- All types in the Godot API have "interior mutability" in Rust parlance.
129
+ All types in the Godot API have _interior mutability_ in Rust parlance.
130
130
To enforce that the official [thread-safety guidelines][thread-safety] are
131
131
followed, the typestate pattern is used in the `Ref` and `TRef` smart pointers,
132
132
and the `Instance` API. The typestate `Access` in these types tracks whether the
0 commit comments