Skip to content

Commit 83a5fda

Browse files
vgezertetrapod00
andauthored
Apply suggestions from code review
Co-authored-by: tetrapod <[email protected]>
1 parent a62bd02 commit 83a5fda

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

tutorials/editor/inspector_dock.rst

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Inspector Dock
44
===============
55

6-
Inspector dock lists all properties of an object, resource, or node.
6+
The Inspector dock lists all properties of an object, resource, or node.
77
It will update the list of the properties as you select a different node from the
8-
Scene Tree dock, or if you use "Open" command from the FileSystem's context menu.
8+
Scene Tree dock, or if you use **Open** command from the FileSystem's context menu.
99

1010
.. image:: img/inspector_overview.webp
1111

@@ -18,7 +18,7 @@ Usage
1818
If the inspector dock is visible, clicking on a node in the scene tree will automatically
1919
display its properties.
2020
If it is not visible, you can show it by navigating to
21-
`Editor > Editor Settings > Editor Docks > Inspector`.
21+
**Editor > Editor Settings > Editor Docks > Inspector**.
2222

2323
At the top of the dock are the file and navigation buttons.
2424

@@ -31,10 +31,10 @@ From left to right:
3131
- Saves the currently edited resource to disk.
3232
- Provides options to:
3333

34-
- `Edit Resource from Clipboard` by pasting the copied resource.
35-
- `Copy Resource` to clipboard.
36-
- `Show in FileSystem` if the resource is already saved.
37-
- `Make Resource Built-In` to work in a built-in resource, not the one from the disk.
34+
- **Edit Resource from Clipboard** by pasting the copied resource.
35+
- **Copy Resource** to clipboard.
36+
- **Show in FileSystem** if the resource is already saved.
37+
- **Make Resource Built-In** to work in a built-in resource, not the one from the disk.
3838

3939
- The "<" and ">" arrows let you navigate through your edited object history.
4040
- The button next to them opens the history list for a quicker navigation. If you created multiple
@@ -55,13 +55,11 @@ what you actually see below it and how it is structured.
5555

5656
.. image:: img/inspector_dock_overlay.webp
5757

58-
Properties are grouped inside their respective `classes` as `sections`.
58+
Properties are grouped inside their respective *classes* as *sections*.
5959
You can expand each section to view the related properties.
60-
The property list of each class can be found in their respective documentation's
61-
`Properties` section.
6260

6361
You can also open the documentation of each class by right-clicking on a class
64-
and selecting "Open Documentation".
62+
and selecting **Open Documentation**.
6563
Similarly, you can right click on a property and copy or paste its value,
6664
copy the property path, favorite it to be shown on the top of the inspector, or open its
6765
documentation page.
@@ -76,7 +74,7 @@ pressed and drag to change the values.
7674
.. image:: img/inspector_dock_subresource.webp
7775

7876
If a node's property is a sub-resource, you can click on the down arrow to pick a
79-
resource type, or load one using the "Quick Load" or "Load" options.
77+
resource type, or load one using the **Quick Load** or **Load** options.
8078
Alternatively, a supported resource can be dragged from the FileSystem.
8179
Once you start dragging, the compatible property will be highlighted.
8280
Simply drop it on the appropriate property's value.
@@ -85,13 +83,13 @@ After loading a sub-resource, you can click on it to see its properties or adjus
8583

8684
.. |undo| image:: img/inspector_dock_revert.webp
8785

88-
The values with different values than their original values will have a |undo| icon.
86+
The values with different values than their original values will have a revert icon (|undo|).
8987
Clicking on this icon reverts the value to its original state.
9088
If the values are linked with each other, they will have a chain icon and changing one
9189
will change others as well. You can unchain them by clicking on this icon.
9290

9391
If you are changing a property a lot, you may consider favoriting it by right-clicking and
94-
choosing `Favorite Property`. This will show it at the top of the inspector for all objects
92+
choosing **Favorite Property**. This will show it at the top of the inspector for all objects
9593
of this class.
9694

9795
Now that we have a better understanding of the terms, we can proceed with the tool menu.
@@ -103,11 +101,11 @@ various view and edit options.
103101
- **Expand All**: Expands all sections showing all available properties.
104102
- **Collapse All**: Collapses all properties showing only classes and the sections.
105103
- **Expand Non-Default**: Only expands the sections where the original value is different
106-
than the current value (the properties with |undo| icon).
104+
than the current value (the properties with a revert icon (|undo|)).
107105
- **Property Name Style**: This section determines how the properties' text is displayed in
108-
the inspector. `Raw` uses the property's own naming, `Capitalized` uses title
106+
the inspector. ``Raw`` uses the property's own naming, ``Capitalized`` uses title
109107
case by changing the initial letters of each word to uppercase and removing underscores,
110-
`Localized` displays the translation of the properties if you are using the Editor
108+
``Localized`` displays the translation of the properties if you are using the Editor
111109
in a language other than English.
112110
- **Copy Properties**: Copies all properties of the current node with their current values.
113111
- **Paste Properties**: Pastes the copied properties from the clipboard. Useful to apply

0 commit comments

Comments
 (0)