From 9d4b48b107c783df1e497a7d3e20c17487914ff3 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 31 Jan 2025 15:11:29 +1100 Subject: [PATCH] Cleanup: spelling in build-files & docs --- .../build_environment/darwin/set_rpath.py | 6 +++--- .../build_environment/install_linux_packages.py | 8 ++++---- build_files/utils/make_utils.py | 2 +- doc/blender_file_format/BlendFileReader.py | 4 ++-- doc/python_api/examples/bpy.props.1.py | 2 +- doc/python_api/examples/bpy.types.Depsgraph.4.py | 2 +- doc/python_api/examples/bpy.types.Menu.1.py | 6 +++--- .../examples/bpy.types.RenderEngine.1.py | 2 +- doc/python_api/examples/gpu.8.py | 4 ++-- doc/python_api/examples/mathutils.Matrix.py | 16 ++++++++-------- 10 files changed, 26 insertions(+), 26 deletions(-) diff --git a/build_files/build_environment/darwin/set_rpath.py b/build_files/build_environment/darwin/set_rpath.py index b971c2972ba..42cfb526ce0 100644 --- a/build_files/build_environment/darwin/set_rpath.py +++ b/build_files/build_environment/darwin/set_rpath.py @@ -16,7 +16,7 @@ import subprocess import sys -# Strip version numbers from dependenciesm macOS notarizatiom fails +# Strip version numbers from dependencies macOS notarizatiom fails # with version symlinks. def strip_lib_version(name): name = re.sub(r'(\.[0-9]+)+.dylib', '.dylib', name) @@ -41,10 +41,10 @@ def main(): file = pathlib.Path(file) new_file = pathlib.Path(new_file) - # Update cmake config files. + # Update CMake configuration files. update_cmake_config(file, new_file) - # Remove if symlink. + # Remove if symbolic-link. if file.is_symlink(): os.remove(file) sys.exit(0) diff --git a/build_files/build_environment/install_linux_packages.py b/build_files/build_environment/install_linux_packages.py index a2f50dd0834..22b4f275634 100755 --- a/build_files/build_environment/install_linux_packages.py +++ b/build_files/build_environment/install_linux_packages.py @@ -535,8 +535,8 @@ DEPS_OPTIONAL_SUBPACKAGES = ( ) -# Python packages that should be available for Blender pyscripts. -# Suse uses names like `python310-Cython` for its python module packages... +# Python packages that should be available for Blender Pythons-scripts. +# SUSE uses names like `python310-Cython` for its python module packages... def suse_pypackages_name_gen(name): def _gen(package, parent_packages): pp = parent_packages[-1] @@ -871,9 +871,9 @@ PACKAGES_ALL = ( ), Package(name="NanoVDB Library", is_mandatory=False, distro_package_names={DISTRO_ID_DEBIAN: "libnanovdb-dev", - DISTRO_ID_FEDORA: ..., # Part of openvdb package. + DISTRO_ID_FEDORA: ..., # Part of OpenVDB package. DISTRO_ID_SUSE: None, - DISTRO_ID_ARCH: ..., # Part of openvdb package. + DISTRO_ID_ARCH: ..., # Part of OpenVDB package. }, ), ), diff --git a/build_files/utils/make_utils.py b/build_files/utils/make_utils.py index 4236be5bc3f..a9b7db22122 100755 --- a/build_files/utils/make_utils.py +++ b/build_files/utils/make_utils.py @@ -242,7 +242,7 @@ def git_update_submodule(git_command: str, submodule_dir: Path) -> bool: # # https://github.com/git/git/commit/7a132c628e57b9bceeb88832ea051395c0637b16 # - # Doing "git lfs pull" after checkout with GIT_LFS_SKIP_SMUDGE=true seems to be the + # Doing `git lfs pull` after checkout with `GIT_LFS_SKIP_SMUDGE=true` seems to be the # valid process. For example, https://www.mankier.com/7/git-lfs-faq env = {"GIT_LFS_SKIP_SMUDGE": "1"} diff --git a/doc/blender_file_format/BlendFileReader.py b/doc/blender_file_format/BlendFileReader.py index 5cb255413b5..7a6c68a82d4 100644 --- a/doc/blender_file_format/BlendFileReader.py +++ b/doc/blender_file_format/BlendFileReader.py @@ -107,8 +107,8 @@ def Align(handle): class BlendFile: ''' - Reads a blendfile and store the header, all the fileblocks, and catalogue - structs found in the DNA fileblock + Reads a blend-file and store the header, all the file-blocks, and catalogue + structs found in the DNA file-block - BlendFile.Header (BlendFileHeader instance) - BlendFile.Blocks (list of BlendFileBlock instances) diff --git a/doc/python_api/examples/bpy.props.1.py b/doc/python_api/examples/bpy.props.1.py index 6ac2148d28c..a8e0c9365c3 100644 --- a/doc/python_api/examples/bpy.props.1.py +++ b/doc/python_api/examples/bpy.props.1.py @@ -4,7 +4,7 @@ Operator Example A common use of custom properties is for python based :class:`Operator` classes. Test this code by running it in the text editor, or by clicking the -button in the 3D Viewport's Tools panel. The latter will show the properties +button in the 3D View-port's Tools panel. The latter will show the properties in the Redo panel and allow you to change them. """ import bpy diff --git a/doc/python_api/examples/bpy.types.Depsgraph.4.py b/doc/python_api/examples/bpy.types.Depsgraph.4.py index e3df30b3f96..78670628fa2 100644 --- a/doc/python_api/examples/bpy.types.Depsgraph.4.py +++ b/doc/python_api/examples/bpy.types.Depsgraph.4.py @@ -13,7 +13,7 @@ animation or modifiers into account: - For meshes this is similar to duplicating the source mesh. - For curves this disables own modifiers, and modifiers of objects used as bevel and taper. -- For metaballs this produces an empty mesh since polygonization is done as a modifier evaluation. +- For meta-balls this produces an empty mesh since polygonization is done as a modifier evaluation. When is used on evaluated object all modifiers are taken into account. diff --git a/doc/python_api/examples/bpy.types.Menu.1.py b/doc/python_api/examples/bpy.types.Menu.1.py index c07e647c660..63eba595221 100644 --- a/doc/python_api/examples/bpy.types.Menu.1.py +++ b/doc/python_api/examples/bpy.types.Menu.1.py @@ -18,17 +18,17 @@ class SubMenu(bpy.types.Menu): layout.operator("object.select_all", text="Inverse").action = 'INVERT' layout.operator("object.select_random", text="Random") - # access this operator as a submenu + # Access this operator as a sub-menu. layout.operator_menu_enum("object.select_by_type", "type", text="Select All by Type...") layout.separator() - # expand each operator option into this menu + # Expand each operator option into this menu. layout.operator_enum("object.light_add", "type") layout.separator() - # use existing memu + # Use existing menu. layout.menu("VIEW3D_MT_transform") diff --git a/doc/python_api/examples/bpy.types.RenderEngine.1.py b/doc/python_api/examples/bpy.types.RenderEngine.1.py index 6ccc55bdc73..232d15ea869 100644 --- a/doc/python_api/examples/bpy.types.RenderEngine.1.py +++ b/doc/python_api/examples/bpy.types.RenderEngine.1.py @@ -39,7 +39,7 @@ class CustomRenderEngine(bpy.types.RenderEngine): self.size_x = int(scene.render.resolution_x * scale) self.size_y = int(scene.render.resolution_y * scale) - # Fill the render result with a flat color. The framebuffer is + # Fill the render result with a flat color. The frame-buffer is # defined as a list of pixels, each pixel itself being a list of # R,G,B,A values. if self.is_preview: diff --git a/doc/python_api/examples/gpu.8.py b/doc/python_api/examples/gpu.8.py index 385b71d0c1a..df2f351e4b8 100644 --- a/doc/python_api/examples/gpu.8.py +++ b/doc/python_api/examples/gpu.8.py @@ -1,6 +1,6 @@ """ -Copy Offscreen Rendering result back to RAM -------------------------------------------- +Copy Off-screen Rendering result back to RAM +-------------------------------------------- This will create a new image with the given name. If it already exists, it will override the existing one. diff --git a/doc/python_api/examples/mathutils.Matrix.py b/doc/python_api/examples/mathutils.Matrix.py index 84e09b97c15..5aa19f93217 100644 --- a/doc/python_api/examples/mathutils.Matrix.py +++ b/doc/python_api/examples/mathutils.Matrix.py @@ -1,32 +1,32 @@ import mathutils import math -# create a location matrix +# Create a location matrix. mat_loc = mathutils.Matrix.Translation((2.0, 3.0, 4.0)) -# create an identitiy matrix +# Create an identity matrix. mat_sca = mathutils.Matrix.Scale(0.5, 4, (0.0, 0.0, 1.0)) -# create a rotation matrix +# Create a rotation matrix. mat_rot = mathutils.Matrix.Rotation(math.radians(45.0), 4, 'X') -# combine transformations +# Combine transformations. mat_out = mat_loc @ mat_rot @ mat_sca print(mat_out) -# extract components back out of the matrix as two vectors and a quaternion +# Extract components back out of the matrix as two vectors and a quaternion. loc, rot, sca = mat_out.decompose() print(loc, rot, sca) -# recombine extracted components +# Recombine extracted components. mat_out2 = mathutils.Matrix.LocRotScale(loc, rot, sca) print(mat_out2) -# it can also be useful to access components of a matrix directly +# It can also be useful to access components of a matrix directly. mat = mathutils.Matrix() mat[0][0], mat[1][0], mat[2][0] = 0.0, 1.0, 2.0 mat[0][0:3] = 0.0, 1.0, 2.0 -# each item in a matrix is a vector so vector utility functions can be used +# Each item in a matrix is a vector so vector utility functions can be used. mat[0].xyz = 0.0, 1.0, 2.0