diff options
author | Campbell Barton <ideasman42@gmail.com> | 2016-02-15 11:37:37 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2016-02-15 11:43:08 +0300 |
commit | 318d3b9ab40bac7b22d10d3e00428c433670d721 (patch) | |
tree | c92dd9c49144712ef7ce32385c955d855d35f6d6 /doc/python_api | |
parent | 41fb953fa0b54d0bb3127bb479833efb6281f178 (diff) |
Cleanup: rst style
Diffstat (limited to 'doc/python_api')
-rw-r--r-- | doc/python_api/examples/bpy.app.translations.py | 9 | ||||
-rw-r--r-- | doc/python_api/examples/bpy.ops.1.py | 1 | ||||
-rw-r--r-- | doc/python_api/examples/bpy.types.Menu.py | 2 | ||||
-rw-r--r-- | doc/python_api/rst/bge.app.rst | 21 | ||||
-rw-r--r-- | doc/python_api/rst/bgl.rst | 1 | ||||
-rw-r--r-- | doc/python_api/rst/gpu.rst | 1 |
6 files changed, 22 insertions, 13 deletions
diff --git a/doc/python_api/examples/bpy.app.translations.py b/doc/python_api/examples/bpy.app.translations.py index 01d5a987215..6ea749c7e1e 100644 --- a/doc/python_api/examples/bpy.app.translations.py +++ b/doc/python_api/examples/bpy.app.translations.py @@ -3,6 +3,7 @@ Intro ----- .. warning:: + Most of this object should only be useful if you actually manipulate i18n stuff from Python. If you are a regular addon, you should only bother about :const:`contexts` member, and the :func:`register`/:func:`unregister` functions! The :func:`pgettext` family of functions @@ -12,12 +13,12 @@ Intro | ``{locale: {msg_key: msg_translation, ...}, ...}`` | where: -* locale is either a lang iso code (e.g. ``fr``), a lang+country code (e.g. ``pt_BR``), +- locale is either a lang iso code (e.g. ``fr``), a lang+country code (e.g. ``pt_BR``), a lang+variant code (e.g. ``sr@latin``), or a full code (e.g. ``uz_UZ@cyrilic``). -* msg_key is a tuple (context, org message) - use, as much as possible, the predefined :const:`contexts`. -* msg_translation is the translated message in given language! +- msg_key is a tuple (context, org message) - use, as much as possible, the predefined :const:`contexts`. +- msg_translation is the translated message in given language! -Then, call ``bpy.app.translations.register(__name__, your_dict)`` in your ``register()`` function, and \n" +Then, call ``bpy.app.translations.register(__name__, your_dict)`` in your ``register()`` function, and ``bpy.app.translations.unregister(__name__)`` in your ``unregister()`` one. The ``Manage UI translations`` addon has several functions to help you collect strings to translate, and diff --git a/doc/python_api/examples/bpy.ops.1.py b/doc/python_api/examples/bpy.ops.1.py index d89a1360c1c..7fdde453abe 100644 --- a/doc/python_api/examples/bpy.ops.1.py +++ b/doc/python_api/examples/bpy.ops.1.py @@ -12,6 +12,7 @@ For example to override ``bpy.context.active_object``, you would pass ``{'active_object': object}``. .. note:: + You will nearly always want to use a copy of the actual current context as basis (otherwise, you'll have to find and gather all needed data yourself). """ diff --git a/doc/python_api/examples/bpy.types.Menu.py b/doc/python_api/examples/bpy.types.Menu.py index c2162444055..295c108abe3 100644 --- a/doc/python_api/examples/bpy.types.Menu.py +++ b/doc/python_api/examples/bpy.types.Menu.py @@ -9,9 +9,11 @@ Notice the 'CATEGORY_MT_name' in :class:`Menu.bl_idname`, this is a naming convention for menus. .. note:: + Menu subclasses must be registered before referencing them from blender. .. note:: + Menus have their :class:`Layout.operator_context` initialized as 'EXEC_REGION_WIN' rather than 'INVOKE_DEFAULT' (see :ref:`Execution Context <operator-execution_context>`). If the operator context needs to initialize inputs from the diff --git a/doc/python_api/rst/bge.app.rst b/doc/python_api/rst/bge.app.rst index a0c2cf36314..34b9263db0c 100644 --- a/doc/python_api/rst/bge.app.rst +++ b/doc/python_api/rst/bge.app.rst @@ -10,38 +10,41 @@ Module to access application values that remain unchanged during runtime. The Blender/BGE version as a tuple of 3 ints, eg. (2, 75, 1). - .. note:: Version tuples can be compared simply with (in)equality symbols; - for example, ``(2, 74, 5) <= (2, 75, 0)`` returns True (lexical order). - + .. note:: + + Version tuples can be compared simply with (in)equality symbols; + for example, ``(2, 74, 5) <= (2, 75, 0)`` returns True (lexical order). + :type: tuple of three ints .. data:: version_string The Blender/BGE version formatted as a string, eg. "2.75 (sub 1)". - + :type: str .. data:: version_char The Blender/BGE version character (for minor releases). - + :type: str .. data:: has_texture_ffmpeg - True if the BGE has been built with FFmpeg support, enabling use of :class:`~bge.texture.ImageFFmpeg` and :class:`~bge.texture.VideoFFmpeg`. - + True if the BGE has been built with FFmpeg support, + enabling use of :class:`~bge.texture.ImageFFmpeg` and :class:`~bge.texture.VideoFFmpeg`. + :type: bool .. data:: has_joystick True if the BGE has been built with joystick support. - + :type: bool .. data:: has_physics True if the BGE has been built with physics support. - + :type: bool diff --git a/doc/python_api/rst/bgl.rst b/doc/python_api/rst/bgl.rst index 8b0ad63abb4..36e07a17cdc 100644 --- a/doc/python_api/rst/bgl.rst +++ b/doc/python_api/rst/bgl.rst @@ -20,6 +20,7 @@ offers a set of extensive examples, including advanced features. .. note:: + You can use the :class:`Image` type to load and set textures. See :class:`Image.gl_load` and :class:`Image.gl_load`, for example. diff --git a/doc/python_api/rst/gpu.rst b/doc/python_api/rst/gpu.rst index 5e7486f22dd..6c38122a573 100644 --- a/doc/python_api/rst/gpu.rst +++ b/doc/python_api/rst/gpu.rst @@ -186,6 +186,7 @@ GLSL Lamp Uniforms mat4_world_to_cam_ * (-vec3_lamp_Z_axis) .. note:: + - The lamp Z axis points to the opposite direction of light. - The norm of the vector should be unit length. |