PyDoc: include keyword only parameter in doc-strings
This commit is contained in:
@@ -33,7 +33,7 @@
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_bm_new_doc,
|
||||
".. method:: new(use_operators=True)\n"
|
||||
".. method:: new(*, use_operators=True)\n"
|
||||
"\n"
|
||||
" :arg use_operators: Support calling operators in :mod:`bmesh.ops` (uses some "
|
||||
"extra memory per vert/edge/face).\n"
|
||||
@@ -95,7 +95,7 @@ void EDBM_update_extern(Mesh *mesh, const bool do_tessface, const bool is_destru
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_bm_update_edit_mesh_doc,
|
||||
".. method:: update_edit_mesh(mesh, loop_triangles=True, destructive=True)\n"
|
||||
".. method:: update_edit_mesh(mesh, *, loop_triangles=True, destructive=True)\n"
|
||||
"\n"
|
||||
" Update the mesh after changes to the BMesh in editmode,\n"
|
||||
" optionally recalculating n-gon tessellation.\n"
|
||||
|
||||
@@ -1268,8 +1268,8 @@ static PyObject *bpy_bmesh_to_mesh(BPy_BMesh *self, PyObject *args)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_bmesh_from_object_doc,
|
||||
".. method:: from_object(object, depsgraph, cage=False, face_normals=True, "
|
||||
"vertex_normals=True)\n"
|
||||
".. method:: from_object(object, depsgraph, *, "
|
||||
"cage=False, face_normals=True, vertex_normals=True)\n"
|
||||
"\n"
|
||||
" Initialize this bmesh from existing object data-block (only meshes are currently "
|
||||
"supported).\n"
|
||||
@@ -1375,8 +1375,8 @@ static PyObject *bpy_bmesh_from_object(BPy_BMesh *self, PyObject *args, PyObject
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_bmesh_from_mesh_doc,
|
||||
".. method:: from_mesh(mesh, face_normals=True, vertex_normals=True, use_shape_key=False, "
|
||||
"shape_key_index=0)\n"
|
||||
".. method:: from_mesh(mesh, *, "
|
||||
"face_normals=True, vertex_normals=True, use_shape_key=False, shape_key_index=0)\n"
|
||||
"\n"
|
||||
" Initialize this bmesh from existing mesh data-block.\n"
|
||||
"\n"
|
||||
@@ -1505,7 +1505,7 @@ static PyObject *bpy_bmesh_normal_update(BPy_BMesh *self)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_bmesh_transform_doc,
|
||||
".. method:: transform(matrix, filter=None)\n"
|
||||
".. method:: transform(matrix, *, filter=None)\n"
|
||||
"\n"
|
||||
" Transform the mesh (optionally filtering flagged data only).\n"
|
||||
"\n"
|
||||
@@ -1570,7 +1570,7 @@ static PyObject *bpy_bmesh_transform(BPy_BMElem *self, PyObject *args, PyObject
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_bmesh_calc_volume_doc,
|
||||
".. method:: calc_volume(signed=False)\n"
|
||||
".. method:: calc_volume(*, signed=False)\n"
|
||||
"\n"
|
||||
" Calculate mesh volume based on face normals.\n"
|
||||
"\n"
|
||||
@@ -2130,7 +2130,7 @@ static PyObject *bpy_bmface_copy_from_face_interp(BPy_BMFace *self, PyObject *ar
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_bmface_copy_doc,
|
||||
".. method:: copy(verts=True, edges=True)\n"
|
||||
".. method:: copy(*, verts=True, edges=True)\n"
|
||||
"\n"
|
||||
" Make a copy of this face.\n"
|
||||
"\n"
|
||||
@@ -2933,7 +2933,7 @@ static PyObject *bpy_bmelemseq_ensure_lookup_table(BPy_BMElemSeq *self)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_bmelemseq_sort_doc,
|
||||
".. method:: sort(key=None, reverse=False)\n"
|
||||
".. method:: sort(*, key=None, reverse=False)\n"
|
||||
"\n"
|
||||
" Sort the elements of this sequence, using an optional custom sort key.\n"
|
||||
" Indices of elements are not changed, :class:`BMElemSeq.index_update` can be used for "
|
||||
|
||||
@@ -399,7 +399,7 @@ static PyObject *bpy_bm_utils_edge_rotate(PyObject * /*self*/, PyObject *args)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_bm_utils_face_split_doc,
|
||||
".. method:: face_split(face, vert_a, vert_b, coords=(), use_exist=True, example=None)\n"
|
||||
".. method:: face_split(face, vert_a, vert_b, *, coords=(), use_exist=True, example=None)\n"
|
||||
"\n"
|
||||
" Face split with optional intermediate points.\n"
|
||||
"\n"
|
||||
|
||||
@@ -632,7 +632,7 @@ static bool idprop_ui_data_update_id(IDProperty *idprop, PyObject *args, PyObjec
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
BPy_IDPropertyUIManager_update_doc,
|
||||
".. method:: update( "
|
||||
".. method:: update(*, "
|
||||
"subtype=None, "
|
||||
"min=None, "
|
||||
"max=None, "
|
||||
|
||||
@@ -72,7 +72,7 @@ static int py_imbuf_valid_check(Py_ImBuf *self)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
py_imbuf_resize_doc,
|
||||
".. method:: resize(size, method='FAST')\n"
|
||||
".. method:: resize(size, *, method='FAST')\n"
|
||||
"\n"
|
||||
" Resize the image.\n"
|
||||
"\n"
|
||||
@@ -653,7 +653,7 @@ static PyObject *imbuf_write_impl(ImBuf *ibuf, const char *filepath)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_imbuf_write_doc,
|
||||
".. function:: write(image, filepath=image.filepath)\n"
|
||||
".. function:: write(image, *, filepath=image.filepath)\n"
|
||||
"\n"
|
||||
" Write an image.\n"
|
||||
"\n"
|
||||
|
||||
@@ -417,7 +417,7 @@ static PyObject *pygpu_framebuffer_is_bound(BPyGPUFrameBuffer *self, void * /*ty
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_framebuffer_clear_doc,
|
||||
".. method:: clear(color=None, depth=None, stencil=None)\n"
|
||||
".. method:: clear(*, color=None, depth=None, stencil=None)\n"
|
||||
"\n"
|
||||
" Fill color, depth and stencil textures with specific value.\n"
|
||||
" Common values: color=(0.0, 0.0, 0.0, 1.0), depth=1.0, stencil=0.\n"
|
||||
@@ -537,7 +537,7 @@ static PyObject *pygpu_framebuffer_viewport_get(BPyGPUFrameBuffer *self, void *
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_framebuffer_read_color_doc,
|
||||
".. function:: read_color(x, y, xsize, ysize, channels, slot, format, data=data)\n"
|
||||
".. function:: read_color(x, y, xsize, ysize, channels, slot, format, *, data=data)\n"
|
||||
"\n"
|
||||
" Read a block of pixels from the frame buffer.\n"
|
||||
"\n"
|
||||
@@ -657,7 +657,7 @@ static PyObject *pygpu_framebuffer_read_color(BPyGPUFrameBuffer *self,
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_framebuffer_read_depth_doc,
|
||||
".. function:: read_depth(x, y, xsize, ysize, data=data)\n"
|
||||
".. function:: read_depth(x, y, xsize, ysize, *, data=data)\n"
|
||||
"\n"
|
||||
" Read a pixel depth block from the frame buffer.\n"
|
||||
"\n"
|
||||
@@ -804,7 +804,7 @@ static PyMethodDef pygpu_framebuffer__tp_methods[] = {
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_framebuffer__tp_doc,
|
||||
".. class:: GPUFrameBuffer(depth_slot=None, color_slots=None)\n"
|
||||
".. class:: GPUFrameBuffer(*, depth_slot=None, color_slots=None)\n"
|
||||
"\n"
|
||||
" This object gives access to framebuffer functionalities.\n"
|
||||
" When a 'layer' is specified in a argument, a single layer of a 3D or array "
|
||||
|
||||
@@ -241,7 +241,7 @@ static PyObject *pygpu_offscreen_bind(BPyGPUOffScreen *self)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_offscreen_unbind_doc,
|
||||
".. method:: unbind(restore=True)\n"
|
||||
".. method:: unbind(*, restore=True)\n"
|
||||
"\n"
|
||||
" Unbind the offscreen object.\n"
|
||||
"\n"
|
||||
@@ -369,7 +369,7 @@ PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_offscreen_draw_view3d_doc,
|
||||
".. method:: draw_view3d(scene, view_layer, view3d, region, view_matrix, projection_matrix, "
|
||||
"do_color_management=False, draw_background=True)\n"
|
||||
"*, do_color_management=False, draw_background=True)\n"
|
||||
"\n"
|
||||
" Draw the 3d viewport in the offscreen object.\n"
|
||||
"\n"
|
||||
|
||||
@@ -913,7 +913,7 @@ static PyObject *pygpu_shader_unbind(BPyGPUShader * /*self*/)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_shader_from_builtin_doc,
|
||||
".. function:: from_builtin(shader_name, config='DEFAULT')\n"
|
||||
".. function:: from_builtin(shader_name, *, config='DEFAULT')\n"
|
||||
"\n"
|
||||
" Shaders that are embedded in the blender internal code (see :ref:`built-in-shaders`).\n"
|
||||
" They all read the uniform ``mat4 ModelViewProjectionMatrix``,\n"
|
||||
|
||||
@@ -582,7 +582,7 @@ static PyObject *pygpu_shader_info_vertex_out(BPyGPUShaderCreateInfo *self,
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_shader_info_fragment_out_doc,
|
||||
".. method:: fragment_out(slot, type, name, blend='NONE')\n"
|
||||
".. method:: fragment_out(slot, type, name, *, blend='NONE')\n"
|
||||
"\n"
|
||||
" Specify a fragment output corresponding to a framebuffer target slot.\n"
|
||||
"\n"
|
||||
@@ -724,7 +724,7 @@ static PyObject *pygpu_shader_info_uniform_buf(BPyGPUShaderCreateInfo *self, PyO
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_shader_info_image_doc,
|
||||
".. method:: image(slot, format, type, name, qualifiers={'NO_RESTRICT'})\n"
|
||||
".. method:: image(slot, format, type, name, *, qualifiers={'NO_RESTRICT'})\n"
|
||||
"\n"
|
||||
" Specify an image resource used for arbitrary load and store operations.\n"
|
||||
"\n"
|
||||
|
||||
@@ -565,7 +565,7 @@ static PyMethodDef pygpu_texture__tp_methods[] = {
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
pygpu_texture__tp_doc,
|
||||
".. class:: GPUTexture(size, layers=0, is_cubemap=False, format='RGBA8', "
|
||||
".. class:: GPUTexture(size, *, layers=0, is_cubemap=False, format='RGBA8', "
|
||||
"data=None)\n"
|
||||
"\n"
|
||||
" This object gives access to off GPU textures.\n"
|
||||
|
||||
@@ -101,7 +101,7 @@ static bool bpy_blend_foreach_path_cb(BPathForeachPathData *bpath_data,
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_blend_paths_doc,
|
||||
".. function:: blend_paths(absolute=False, packed=False, local=False)\n"
|
||||
".. function:: blend_paths(*, absolute=False, packed=False, local=False)\n"
|
||||
"\n"
|
||||
" Returns a list of paths to external files referenced by the loaded .blend file.\n"
|
||||
"\n"
|
||||
@@ -171,7 +171,7 @@ static PyObject *bpy_blend_paths(PyObject * /*self*/, PyObject *args, PyObject *
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_flip_name_doc,
|
||||
".. function:: flip_name(name, strip_digits=False)\n"
|
||||
".. function:: flip_name(name, *, strip_digits=False)\n"
|
||||
"\n"
|
||||
" Flip a name between left/right sides, useful for \n"
|
||||
" mirroring bone names.\n"
|
||||
@@ -217,7 +217,7 @@ static PyObject *bpy_flip_name(PyObject * /*self*/, PyObject *args, PyObject *kw
|
||||
return result;
|
||||
}
|
||||
|
||||
/* `bpy_user_resource_doc`, Now in `bpy/utils.py`. */
|
||||
/* `bpy_user_resource_doc`, Now in `bpy/utils/__init__.py`. */
|
||||
static PyObject *bpy_user_resource(PyObject * /*self*/, PyObject *args, PyObject *kw)
|
||||
{
|
||||
const PyC_StringEnumItems type_items[] = {
|
||||
@@ -263,7 +263,7 @@ static PyObject *bpy_user_resource(PyObject * /*self*/, PyObject *args, PyObject
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_system_resource_doc,
|
||||
".. function:: system_resource(type, path=\"\")\n"
|
||||
".. function:: system_resource(type, *, path=\"\")\n"
|
||||
"\n"
|
||||
" Return a system resource path.\n"
|
||||
"\n"
|
||||
@@ -314,7 +314,7 @@ static PyObject *bpy_system_resource(PyObject * /*self*/, PyObject *args, PyObje
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_resource_path_doc,
|
||||
".. function:: resource_path(type, major=bpy.app.version[0], minor=bpy.app.version[1])\n"
|
||||
".. function:: resource_path(type, *, major=bpy.app.version[0], minor=bpy.app.version[1])\n"
|
||||
"\n"
|
||||
" Return the base path for storing system files.\n"
|
||||
"\n"
|
||||
@@ -365,7 +365,7 @@ static PyObject *bpy_resource_path(PyObject * /*self*/, PyObject *args, PyObject
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_driver_secure_code_test_doc,
|
||||
".. function:: _driver_secure_code_test(code)\n"
|
||||
".. function:: _driver_secure_code_test(code, *, namespace=None, verbose=False)\n"
|
||||
"\n"
|
||||
" Test if the script should be considered trusted.\n"
|
||||
"\n"
|
||||
|
||||
@@ -606,7 +606,7 @@ char *(*BPY_python_app_help_text_fn)(bool all) = nullptr;
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_app_help_text_doc,
|
||||
".. staticmethod:: help_text(all=False)\n"
|
||||
".. staticmethod:: help_text(*, all=False)\n"
|
||||
"\n"
|
||||
" Return the help text as a string.\n"
|
||||
"\n"
|
||||
|
||||
@@ -68,7 +68,7 @@ static void py_timer_free(uintptr_t /*uuid*/, void *user_data)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_app_timers_register_doc,
|
||||
".. function:: register(function, first_interval=0, persistent=False)\n"
|
||||
".. function:: register(function, *, first_interval=0, persistent=False)\n"
|
||||
"\n"
|
||||
" Add a new function that will be called after the specified amount of seconds.\n"
|
||||
" The function gets no arguments and is expected to return either None or a float.\n"
|
||||
|
||||
@@ -204,6 +204,7 @@ PyDoc_STRVAR(
|
||||
bpy_lib_load_doc,
|
||||
".. method:: load("
|
||||
"filepath, "
|
||||
"*, "
|
||||
"link=False, "
|
||||
"relative=False, "
|
||||
"set_fake=False, "
|
||||
|
||||
@@ -37,7 +37,8 @@ using namespace blender::bke::blendfile;
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_lib_write_doc,
|
||||
".. method:: write(filepath, datablocks, path_remap=False, fake_user=False, compress=False)\n"
|
||||
".. method:: write(filepath, datablocks, *, "
|
||||
"path_remap=False, fake_user=False, compress=False)\n"
|
||||
"\n"
|
||||
" Write data-blocks into a blend file.\n"
|
||||
"\n"
|
||||
|
||||
@@ -190,7 +190,7 @@ static void bpy_msgbus_subscribe_value_free_data(wmMsgSubscribeKey * /*msg_key*/
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_msgbus_subscribe_rna_doc,
|
||||
".. function:: subscribe_rna(key, owner, args, notify, options=set())\n"
|
||||
".. function:: subscribe_rna(key, owner, args, notify, *, options=set())\n"
|
||||
"\n"
|
||||
" Register a message bus subscription. It will be cleared when another blend file is\n"
|
||||
" loaded, or can be cleared explicitly via :func:`bpy.msgbus.clear_by_owner`.\n"
|
||||
|
||||
@@ -137,7 +137,7 @@ static PyTypeObject bpy_rna_data_context_Type = {
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_rna_data_context_load_doc,
|
||||
".. method:: temp_data(filepath=None)\n"
|
||||
".. method:: temp_data(*, filepath=None)\n"
|
||||
"\n"
|
||||
" A context manager that temporarily creates blender file data.\n"
|
||||
"\n"
|
||||
|
||||
@@ -357,7 +357,7 @@ static void foreach_id_file_path_map(BPathForeachPathData &bpath_data)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_file_path_map_doc,
|
||||
".. method:: file_path_map(subset=None, key_types=None, include_libraries=False)\n"
|
||||
".. method:: file_path_map(*, subset=None, key_types=None, include_libraries=False)\n"
|
||||
"\n"
|
||||
" Returns a mapping of all ID data-blocks in current ``bpy.data`` to a set of all "
|
||||
"file paths used by them.\n"
|
||||
|
||||
@@ -46,7 +46,7 @@ struct TextRegion {
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_rna_region_as_string_doc,
|
||||
".. method:: region_as_string(range=None)\n"
|
||||
".. method:: region_as_string(*, range=None)\n"
|
||||
"\n"
|
||||
" :arg range: The region of text to be returned, "
|
||||
"defaulting to the selection when no range is passed.\n"
|
||||
@@ -123,7 +123,7 @@ PyMethodDef BPY_rna_region_as_string_method_def = {
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpy_rna_region_from_string_doc,
|
||||
".. method:: region_from_string(body, range=None)\n"
|
||||
".. method:: region_from_string(body, /, *, range=None)\n"
|
||||
"\n"
|
||||
" :arg body: The text to be inserted.\n"
|
||||
" :type body: str\n"
|
||||
|
||||
@@ -146,7 +146,7 @@ static bool bpyunits_validate(const char *usys_str, const char *ucat_str, int *r
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpyunits_to_value_doc,
|
||||
".. method:: to_value(unit_system, unit_category, str_input, str_ref_unit=None)\n"
|
||||
".. method:: to_value(unit_system, unit_category, str_input, *, str_ref_unit=None)\n"
|
||||
"\n"
|
||||
" Convert a given input string into a float value.\n"
|
||||
"\n"
|
||||
@@ -229,7 +229,7 @@ static PyObject *bpyunits_to_value(PyObject * /*self*/, PyObject *args, PyObject
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
bpyunits_to_string_doc,
|
||||
".. method:: to_string(unit_system, unit_category, value, precision=3, "
|
||||
".. method:: to_string(unit_system, unit_category, value, *, precision=3, "
|
||||
"split_unit=False, compatible_unit=False)\n"
|
||||
"\n"
|
||||
" Convert a given input float value into a string with units.\n"
|
||||
|
||||
@@ -636,7 +636,7 @@ static PyObject *py_bvhtree_overlap(PyBVHTree *self, PyBVHTree *other)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
C_BVHTree_FromPolygons_doc,
|
||||
".. classmethod:: FromPolygons(vertices, polygons, all_triangles=False, epsilon=0.0)\n"
|
||||
".. classmethod:: FromPolygons(vertices, polygons, *, all_triangles=False, epsilon=0.0)\n"
|
||||
"\n"
|
||||
" BVH tree constructed geometry passed in as arguments.\n"
|
||||
"\n"
|
||||
@@ -928,7 +928,7 @@ static PyObject *C_BVHTree_FromPolygons(PyObject * /*cls*/, PyObject *args, PyOb
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
C_BVHTree_FromBMesh_doc,
|
||||
".. classmethod:: FromBMesh(bmesh, epsilon=0.0)\n"
|
||||
".. classmethod:: FromBMesh(bmesh, *, epsilon=0.0)\n"
|
||||
"\n"
|
||||
" BVH tree based on :class:`BMesh` data.\n"
|
||||
"\n"
|
||||
@@ -1126,7 +1126,7 @@ static const Mesh *bvh_get_mesh(const char *funcname,
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
C_BVHTree_FromObject_doc,
|
||||
".. classmethod:: FromObject(object, depsgraph, deform=True, render=False, "
|
||||
".. classmethod:: FromObject(object, depsgraph, *, deform=True, render=False, "
|
||||
"cage=False, epsilon=0.0)\n"
|
||||
"\n"
|
||||
" BVH tree based on :class:`Object` data.\n"
|
||||
|
||||
@@ -198,7 +198,7 @@ static int py_find_nearest_cb(void *user_data, int index, const float co[3], flo
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
py_kdtree_find_doc,
|
||||
".. method:: find(co, filter=None)\n"
|
||||
".. method:: find(co, *, filter=None)\n"
|
||||
"\n"
|
||||
" Find nearest point to ``co``.\n"
|
||||
"\n"
|
||||
|
||||
@@ -295,7 +295,7 @@ static PyObject *M_Noise_random(PyObject * /*self*/)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_random_unit_vector_doc,
|
||||
".. function:: random_unit_vector(size=3)\n"
|
||||
".. function:: random_unit_vector(*, size=3)\n"
|
||||
"\n"
|
||||
" Returns a unit vector with random entries.\n"
|
||||
"\n"
|
||||
@@ -331,7 +331,7 @@ static PyObject *M_Noise_random_unit_vector(PyObject * /*self*/, PyObject *args,
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_random_vector_doc,
|
||||
".. function:: random_vector(size=3)\n"
|
||||
".. function:: random_vector(*, size=3)\n"
|
||||
"\n"
|
||||
" Returns a vector with random entries in the range (-1, 1).\n"
|
||||
"\n"
|
||||
@@ -384,7 +384,7 @@ static PyObject *M_Noise_seed_set(PyObject * /*self*/, PyObject *args)
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_noise_doc,
|
||||
".. function:: noise(position, /, noise_basis='PERLIN_ORIGINAL')\n"
|
||||
".. function:: noise(position, /, *, noise_basis='PERLIN_ORIGINAL')\n"
|
||||
"\n"
|
||||
" Returns noise value from the noise basis at the position specified.\n"
|
||||
"\n"
|
||||
@@ -427,7 +427,7 @@ static PyObject *M_Noise_noise(PyObject * /*self*/, PyObject *args, PyObject *kw
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_noise_vector_doc,
|
||||
".. function:: noise_vector(position, noise_basis='PERLIN_ORIGINAL')\n"
|
||||
".. function:: noise_vector(position, /, *, noise_basis='PERLIN_ORIGINAL')\n"
|
||||
"\n"
|
||||
" Returns the noise vector from the noise basis at the specified position.\n"
|
||||
"\n"
|
||||
@@ -470,8 +470,8 @@ static PyObject *M_Noise_noise_vector(PyObject * /*self*/, PyObject *args, PyObj
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_turbulence_doc,
|
||||
".. function:: turbulence(position, octaves, hard, /, noise_basis='PERLIN_ORIGINAL', "
|
||||
"amplitude_scale=0.5, frequency_scale=2.0)\n"
|
||||
".. function:: turbulence(position, octaves, hard, /, *, "
|
||||
"noise_basis='PERLIN_ORIGINAL', amplitude_scale=0.5, frequency_scale=2.0)\n"
|
||||
"\n"
|
||||
" Returns the turbulence value from the noise basis at the specified position.\n"
|
||||
"\n"
|
||||
@@ -531,7 +531,7 @@ static PyObject *M_Noise_turbulence(PyObject * /*self*/, PyObject *args, PyObjec
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_turbulence_vector_doc,
|
||||
".. function:: turbulence_vector(position, octaves, hard, /, "
|
||||
".. function:: turbulence_vector(position, octaves, hard, /, *, "
|
||||
"noise_basis='PERLIN_ORIGINAL', amplitude_scale=0.5, frequency_scale=2.0)\n"
|
||||
"\n"
|
||||
" Returns the turbulence vector from the noise basis at the specified position.\n"
|
||||
@@ -595,7 +595,8 @@ static PyObject *M_Noise_turbulence_vector(PyObject * /*self*/, PyObject *args,
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_fractal_doc,
|
||||
".. function:: fractal(position, H, lacunarity, octaves, /, noise_basis='PERLIN_ORIGINAL')\n"
|
||||
".. function:: fractal(position, H, lacunarity, octaves, /, *, "
|
||||
"noise_basis='PERLIN_ORIGINAL')\n"
|
||||
"\n"
|
||||
" Returns the fractal Brownian motion (fBm) noise value from the noise basis at the "
|
||||
"specified position.\n"
|
||||
@@ -645,7 +646,7 @@ static PyObject *M_Noise_fractal(PyObject * /*self*/, PyObject *args, PyObject *
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_multi_fractal_doc,
|
||||
".. function:: multi_fractal(position, H, lacunarity, octaves, /, "
|
||||
".. function:: multi_fractal(position, H, lacunarity, octaves, /, *, "
|
||||
"noise_basis='PERLIN_ORIGINAL')\n"
|
||||
"\n"
|
||||
" Returns multifractal noise value from the noise basis at the specified position.\n"
|
||||
@@ -702,7 +703,7 @@ static PyObject *M_Noise_multi_fractal(PyObject * /*self*/, PyObject *args, PyOb
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_variable_lacunarity_doc,
|
||||
".. function:: variable_lacunarity(position, distortion, /, "
|
||||
".. function:: variable_lacunarity(position, distortion, /, *, "
|
||||
"noise_type1='PERLIN_ORIGINAL', noise_type2='PERLIN_ORIGINAL')\n"
|
||||
"\n"
|
||||
" Returns variable lacunarity noise value, a distorted variety of noise, from "
|
||||
@@ -775,7 +776,7 @@ static PyObject *M_Noise_variable_lacunarity(PyObject * /*self*/, PyObject *args
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_hetero_terrain_doc,
|
||||
".. function:: hetero_terrain(position, H, lacunarity, octaves, offset, /, "
|
||||
".. function:: hetero_terrain(position, H, lacunarity, octaves, offset, /, *, "
|
||||
"noise_basis='PERLIN_ORIGINAL')\n"
|
||||
"\n"
|
||||
" Returns the heterogeneous terrain value from the noise basis at the specified position.\n"
|
||||
@@ -835,7 +836,7 @@ static PyObject *M_Noise_hetero_terrain(PyObject * /*self*/, PyObject *args, PyO
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_hybrid_multi_fractal_doc,
|
||||
".. function:: hybrid_multi_fractal(position, H, lacunarity, octaves, offset, gain, /, "
|
||||
".. function:: hybrid_multi_fractal(position, H, lacunarity, octaves, offset, gain, /, *, "
|
||||
"noise_basis='PERLIN_ORIGINAL')\n"
|
||||
"\n"
|
||||
" Returns hybrid multifractal value from the noise basis at the specified position.\n"
|
||||
@@ -900,7 +901,7 @@ static PyObject *M_Noise_hybrid_multi_fractal(PyObject * /*self*/, PyObject *arg
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_ridged_multi_fractal_doc,
|
||||
".. function:: ridged_multi_fractal(position, H, lacunarity, octaves, offset, gain, /, "
|
||||
".. function:: ridged_multi_fractal(position, H, lacunarity, octaves, offset, gain, /, *, "
|
||||
"noise_basis='PERLIN_ORIGINAL')\n"
|
||||
"\n"
|
||||
" Returns ridged multifractal value from the noise basis at the specified position.\n"
|
||||
@@ -965,7 +966,7 @@ static PyObject *M_Noise_ridged_multi_fractal(PyObject * /*self*/, PyObject *arg
|
||||
PyDoc_STRVAR(
|
||||
/* Wrap. */
|
||||
M_Noise_voronoi_doc,
|
||||
".. function:: voronoi(position, /, distance_metric='DISTANCE', exponent=2.5)\n"
|
||||
".. function:: voronoi(position, /, *, distance_metric='DISTANCE', exponent=2.5)\n"
|
||||
"\n"
|
||||
" Returns a list of distances to the four closest features and their locations.\n"
|
||||
"\n"
|
||||
|
||||
Reference in New Issue
Block a user