Skip to content

Commit cd8f5df

Browse files
committed
Minor doc improvements for API classes
1 parent d00b9f5 commit cd8f5df

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

bindings_generator/src/documentation.rs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pub fn class_doc_link(class: &GodotClass) -> String {
1212

1313
pub fn official_doc_url(class: &GodotClass) -> String {
1414
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",
1616
lower_case = class.name.to_lowercase(),
1717
)
1818
}
@@ -31,31 +31,31 @@ pub fn generate_module_doc(class: &GodotClass) -> TokenStream {
3131
pub fn generate_class_documentation(api: &Api, class: &GodotClass) -> TokenStream {
3232
let has_parent = !class.base_class.is_empty();
3333
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"
3636
} else {
37-
"unsafe"
37+
"manually managed"
3838
};
3939

4040
let mut summary_doc = if &class.name == "Reference" {
4141
"Base class of all reference-counted types. Inherits `Object`.".into()
4242
} 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()
4444
} else if has_parent {
4545
format!(
46-
"`{api_type} {singleton}class {name}` inherits `{base_class}` ({ownership_type}).",
46+
"`{api_type} {singleton}class {name}` inherits `{base_class}` ({memory_type}).",
4747
api_type = class.api_type,
4848
name = class.name,
4949
base_class = class.base_class,
50-
ownership_type = ownership_type,
50+
memory_type = memory_type,
5151
singleton = singleton_str,
5252
)
5353
} else {
5454
format!(
55-
"`{api_type} {singleton}class {name}` ({ownership_type})",
55+
"`{api_type} {singleton}class {name}` ({memory_type})",
5656
api_type = class.api_type,
5757
name = class.name,
58-
ownership_type = ownership_type,
58+
memory_type = memory_type,
5959
singleton = singleton_str,
6060
)
6161
};
@@ -79,7 +79,7 @@ The lifetime of this object is automatically managed through reference counting.
7979
format!(
8080
r#"## Memory management
8181
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.
8383
8484
`{name}` is a reference-only type. Persistent references can
8585
only exist in the unsafe `Ref<{name}>` form.
@@ -126,7 +126,7 @@ This class is used to interact with Godot's editor."#
126126
let safety_doc = r#"
127127
## Safety
128128
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.
130130
To enforce that the official [thread-safety guidelines][thread-safety] are
131131
followed, the typestate pattern is used in the `Ref` and `TRef` smart pointers,
132132
and the `Instance` API. The typestate `Access` in these types tracks whether the

0 commit comments

Comments
 (0)