Skip to content

Commit e3d5b49

Browse files
committed
docs: remove deprecated config usage example
1 parent 4d6a0db commit e3d5b49

File tree

1 file changed

+0
-19
lines changed

1 file changed

+0
-19
lines changed

docs/source/getting_started/config.rst

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -83,22 +83,3 @@ Its value is a dictionary, passed in as ``kwargs`` when initializing the ``Camer
8383
to modify the value of the properties of the ``Camera`` class.
8484

8585
So the nesting of the ``CONFIG`` dictionary **essentially** passes in the value as ``kwargs``.
86-
87-
Common usage
88-
------------
89-
90-
When writing a class by yourself, you can add attributes or modify the attributes
91-
of the parent class through ``CONFIG``.
92-
93-
The most commonly used is to modify the properties of the camera when writing a ``Scene``:
94-
95-
.. code-block:: python
96-
97-
class YourScene(Scene):
98-
CONFIG = {
99-
"camera_config": {
100-
"background_color": WHITE,
101-
},
102-
}
103-
104-
For example, the above dictionary will change the background color to white, etc.

0 commit comments

Comments
 (0)