correcting typos in python api docs
authorInes Almeida <britalmeida@gmail.com>
Fri, 24 Apr 2015 13:08:31 +0000 (14:08 +0100)
committerInes Almeida <britalmeida@gmail.com>
Fri, 24 Apr 2015 13:08:31 +0000 (14:08 +0100)
doc/python_api/examples/bpy.ops.2.py
doc/python_api/examples/bpy.props.2.py
doc/python_api/examples/bpy.props.py
doc/python_api/examples/bpy.types.Menu.2.py
doc/python_api/examples/bpy.types.Menu.py
source/blender/python/intern/bpy_props.c

index cf6df946873c7773d5911c3a60e98a74b91d7967..87a2022e52625adb5e273a7042e267bf37c19d6f 100644 (file)
@@ -1,16 +1,19 @@
+.. _operator-execution_context:
+
 """
 Execution Context
 -----------------
 
 When calling an operator you may want to pass the execution context.
 
-This determines the context thats given to the operator to run in, and weather
-invoke() is called or execute().
+This determines the context that is given for the operator to run in, and whether
+invoke() is called or only execute().
 
-'EXEC_DEFAULT' is used by default but you may want the operator to take user
-interaction with 'INVOKE_DEFAULT'.
+'EXEC_DEFAULT' is used by default, running only the execute() method, but you may
+want the operator to take user interaction with 'INVOKE_DEFAULT' which will also
+call invoke() if existing.
 
-The execution context is as a non keyword, string argument in:
+The execution context is one of:
 ('INVOKE_DEFAULT', 'INVOKE_REGION_WIN', 'INVOKE_REGION_CHANNELS',
 'INVOKE_REGION_PREVIEW', 'INVOKE_AREA', 'INVOKE_SCREEN', 'EXEC_DEFAULT',
 'EXEC_REGION_WIN', 'EXEC_REGION_CHANNELS', 'EXEC_REGION_PREVIEW', 'EXEC_AREA',
index 22fef5dc13a45ce515184340be8ce0482f5ebd55..ec9c838f5f22c4ab93ec8b2031a545591a921fda 100644 (file)
@@ -3,7 +3,7 @@ PropertyGroup Example
 +++++++++++++++++++++
 
 PropertyGroups can be used for collecting custom settings into one value
-to avoid many indervidual settings mixed in together.
+to avoid many individual settings mixed in together.
 """
 
 import bpy
index f6bc55d6824c51a227576cf11f2deafa387195b4..c199bd9b83ad0e2fa761d134d458632ead06c37a 100644 (file)
@@ -6,7 +6,7 @@ Custom properties can be added to any subclass of an :class:`ID`,
 :class:`Bone` and :class:`PoseBone`.
 
 These properties can be animated, accessed by the user interface and python
-like blenders existing properties.
+like Blender's existing properties.
 """
 
 import bpy
index c87b10cb6e74c2c1d4a7c6add4bcec1bba301ef9..26409f12f45a701703b34719a3bda56ff30f572e 100644 (file)
@@ -1,12 +1,11 @@
 """
 Extending Menus
 +++++++++++++++
-When creating menus for addons you can't reference menus in blenders default
+When creating menus for addons you can't reference menus in Blender's default
 scripts.
+Instead, the addon can add menu items to existing menus.
 
-Instead the addon can add menu items to existing menus.
-
-The function menu_draw acts like Menu.draw
+The function menu_draw acts like :class:`Menu.draw`.
 """
 import bpy
 
index 4ca18a67b783b35998566cbfd12731ff2efa0336..e10e44f108e3596c17b79abdc685249400322582 100644 (file)
@@ -1,21 +1,20 @@
 """
 Basic Menu Example
 ++++++++++++++++++
-This script is a simple menu, menus differ from panels in that they must
+Here is an example of a simple menu. Menus differ from panels in that they must
 reference from a header, panel or another menu.
 
-Notice the 'CATEGORY_MT_name' :class:`Menu.bl_idname`, this is a naming
+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::
-   Menu's have their :class:`Layout.operator_context` initialized as
-   'EXEC_REGION_WIN' rather then 'INVOKE_DEFAULT', so if the operator context
-   needs to initialize inputs from the :class:`Operator.invoke` function
-   then this needs to be explicitly set.
+   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
+   :class:`Operator.invoke` function, then this needs to be explicitly set.
 """
 import bpy
 
index 8370aea4c99d7aa999345ef35fab25ae9084dd69..0e9e6b74396490533f9a1758aa68d39382d0c64a 100644 (file)
@@ -2965,9 +2965,10 @@ static struct PyMethodDef props_methods[] = {
 static struct PyModuleDef props_module = {
        PyModuleDef_HEAD_INIT,
        "bpy.props",
-       "This module defines properties to extend blenders internal data, the result of these functions"
-       " is used to assign properties to classes registered with blender and can't be used directly.\n"
-       ".. warning:: All parameters to these functions must be passed as keywords.",
+       "This module defines properties to extend Blender's internal data. The result of these functions"
+       " is used to assign properties to classes registered with Blender and can't be used directly.\n"
+       "\n"
+       ".. warning:: All parameters to these functions must be passed as keywords.\n",
        -1, /* multiple "initialization" just copies the module dict. */
        props_methods,
        NULL, NULL, NULL, NULL