update func name

xyluo25 · Mar 30, 2024 · 44af614 · 44af614
1 parent ef0c14f
commit 44af614
Show file tree

Hide file tree

Showing 76 changed files with 155 additions and 159 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ pf.show_util_func_by_category()
 pf.show_util_func_by_keyword()
 
 # show all available functions by keyword in func_name
-pf.find_func_by_keyword("show")
+pf.find_util_func_by_keyword("show")
 
 ```
 

diff --git a/docs/source/reference/api/pyufunc.add_dir_to_env.rst b/docs/source/reference/api/pyufunc.add_dir_to_env.rst
@@ -1,5 +1,5 @@
-pyufunc.adddir\_to\_env
-=======================
+pyufunc.add\_dir\_to\_env
+=========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.calc_distance_on_unit_sphere.rst b/docs/source/reference/api/pyufunc.calc_distance_on_unit_sphere.rst
@@ -1,5 +1,5 @@
-pyufunc.calcdistance\_on\_unit\_sphere
-======================================
+pyufunc.calc\_distance\_on\_unit\_sphere
+========================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.check_filename.rst b/docs/source/reference/api/pyufunc.check_filename.rst
@@ -1,5 +1,5 @@
-pyufunc.checkfilename
-=====================
+pyufunc.check\_filename
+=======================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.check_files_existence.rst b/docs/source/reference/api/pyufunc.check_files_existence.rst
@@ -1,5 +1,5 @@
-pyufunc.checkfiles\_existence
-=============================
+pyufunc.check\_files\_existence
+===============================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.check_platform.rst b/docs/source/reference/api/pyufunc.check_platform.rst
@@ -1,5 +1,5 @@
-pyufunc.checkplatform
-=====================
+pyufunc.check\_platform
+=======================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.create_circle_at_point_with_radius.rst b/docs/source/reference/api/pyufunc.create_circle_at_point_with_radius.rst
@@ -1,5 +1,5 @@
-pyufunc.createcircle\_at\_point\_with\_radius
-=============================================
+pyufunc.create\_circle\_at\_point\_with\_radius
+===============================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.create_tempfile.rst b/docs/source/reference/api/pyufunc.create_tempfile.rst
@@ -1,5 +1,5 @@
-pyufunc.createtempfile
-======================
+pyufunc.create\_tempfile
+========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.cvt_PIL_img_to_bytes.rst b/docs/source/reference/api/pyufunc.cvt_PIL_img_to_bytes.rst
@@ -1,5 +1,5 @@
-pyufunc.cvtPIL\_img\_to\_bytes
-==============================
+pyufunc.cvt\_PIL\_img\_to\_bytes
+================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.cvt_dt_to_tz.rst b/docs/source/reference/api/pyufunc.cvt_dt_to_tz.rst
@@ -1,5 +1,5 @@
-pyufunc.cvtdt\_to\_tz
-=====================
+pyufunc.cvt\_dt\_to\_tz
+=======================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.cvt_img_CV_to_PIL.rst b/docs/source/reference/api/pyufunc.cvt_img_CV_to_PIL.rst
@@ -1,5 +1,5 @@
-pyufunc.cvtimg\_CV\_to\_PIL
-===========================
+pyufunc.cvt\_img\_CV\_to\_PIL
+=============================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.cvt_img_PIL_to_CV.rst b/docs/source/reference/api/pyufunc.cvt_img_PIL_to_CV.rst
@@ -1,5 +1,5 @@
-pyufunc.cvtimg\_PIL\_to\_CV
-===========================
+pyufunc.cvt\_img\_PIL\_to\_CV
+=============================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.cvt_img_bytes_to_PIL_img.rst b/docs/source/reference/api/pyufunc.cvt_img_bytes_to_PIL_img.rst
@@ -1,5 +1,5 @@
-pyufunc.cvtimg\_bytes\_to\_PIL\_img
-===================================
+pyufunc.cvt\_img\_bytes\_to\_PIL\_img
+=====================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.cvt_img_to_bytes.rst b/docs/source/reference/api/pyufunc.cvt_img_to_bytes.rst
@@ -1,5 +1,5 @@
-pyufunc.cvtimg\_to\_bytes
-=========================
+pyufunc.cvt\_img\_to\_bytes
+===========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.cvt_int_to_alpha.rst b/docs/source/reference/api/pyufunc.cvt_int_to_alpha.rst
@@ -1,5 +1,5 @@
-pyufunc.cvtint\_to\_alpha
-=========================
+pyufunc.cvt\_int\_to\_alpha
+===========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.find_closest_point.rst b/docs/source/reference/api/pyufunc.find_closest_point.rst
@@ -1,5 +1,5 @@
-pyufunc.findclosest\_point
-==========================
+pyufunc.find\_closest\_point
+============================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.find_func_by_keyword.rst b/docs/source/reference/api/pyufunc.find_func_by_keyword.rst
diff --git a/docs/source/reference/api/pyufunc.find_k_nearest_points.rst b/docs/source/reference/api/pyufunc.find_k_nearest_points.rst
@@ -1,5 +1,5 @@
-pyufunc.findk\_nearest\_points
-==============================
+pyufunc.find\_k\_nearest\_points
+================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.find_util_func_by_keyword.rst b/docs/source/reference/api/pyufunc.find_util_func_by_keyword.rst
@@ -0,0 +1,7 @@
+pyufunc.find\_util\_func\_by\_keyword
+=====================================
+
+.. automodule:: pyufunc
+
+.. autofunction:: find_util_func_by_keyword
+
diff --git a/docs/source/reference/api/pyufunc.fmt_dt_to_str.rst b/docs/source/reference/api/pyufunc.fmt_dt_to_str.rst
@@ -1,5 +1,5 @@
-pyufunc.fmtdt\_to\_str
-======================
+pyufunc.fmt\_dt\_to\_str
+========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.func_running_time.rst b/docs/source/reference/api/pyufunc.func_running_time.rst
@@ -1,5 +1,5 @@
-pyufunc.funcrunning\_time
-=========================
+pyufunc.func\_running\_time
+===========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.func_time.rst b/docs/source/reference/api/pyufunc.func_time.rst
@@ -1,5 +1,5 @@
-pyufunc.functime
-================
+pyufunc.func\_time
+==================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.generate_password.rst b/docs/source/reference/api/pyufunc.generate_password.rst
@@ -1,5 +1,5 @@
-pyufunc.generatepassword
-========================
+pyufunc.generate\_password
+==========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.generate_unique_filename.rst b/docs/source/reference/api/pyufunc.generate_unique_filename.rst
@@ -1,5 +1,5 @@
-pyufunc.generateunique\_filename
-================================
+pyufunc.generate\_unique\_filename
+==================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.get_coordinates_from_geom.rst b/docs/source/reference/api/pyufunc.get_coordinates_from_geom.rst
@@ -1,5 +1,5 @@
-pyufunc.getcoordinates\_from\_geom
-==================================
+pyufunc.get\_coordinates\_from\_geom
+====================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.get_dir_size.rst b/docs/source/reference/api/pyufunc.get_dir_size.rst
@@ -1,5 +1,5 @@
-pyufunc.getdir\_size
-====================
+pyufunc.get\_dir\_size
+======================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.get_file_size.rst b/docs/source/reference/api/pyufunc.get_file_size.rst
@@ -1,5 +1,5 @@
-pyufunc.getfile\_size
-=====================
+pyufunc.get\_file\_size
+=======================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.get_filenames_by_ext.rst b/docs/source/reference/api/pyufunc.get_filenames_by_ext.rst
@@ -1,5 +1,5 @@
-pyufunc.getfilenames\_by\_ext
-=============================
+pyufunc.get\_filenames\_by\_ext
+===============================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.get_host_ip.rst b/docs/source/reference/api/pyufunc.get_host_ip.rst
@@ -1,5 +1,5 @@
-pyufunc.gethost\_ip
-===================
+pyufunc.get\_host\_ip
+=====================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.get_time_diff_in_unit.rst b/docs/source/reference/api/pyufunc.get_time_diff_in_unit.rst
@@ -1,5 +1,5 @@
-pyufunc.gettime\_diff\_in\_unit
-===============================
+pyufunc.get\_time\_diff\_in\_unit
+=================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.get_timezone.rst b/docs/source/reference/api/pyufunc.get_timezone.rst
@@ -1,5 +1,5 @@
-pyufunc.gettimezone
-===================
+pyufunc.get\_timezone
+=====================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.get_user_defined_func.rst b/docs/source/reference/api/pyufunc.get_user_defined_func.rst
@@ -1,5 +1,5 @@
-pyufunc.getuser\_defined\_func
-==============================
+pyufunc.get\_user\_defined\_func
+================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.github_file_downloader.rst b/docs/source/reference/api/pyufunc.github_file_downloader.rst
@@ -1,5 +1,5 @@
-pyufunc.githubfile\_downloader
-==============================
+pyufunc.github\_file\_downloader
+================================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.github_get_status.rst b/docs/source/reference/api/pyufunc.github_get_status.rst
@@ -1,5 +1,5 @@
-pyufunc.githubget\_status
-=========================
+pyufunc.github\_get\_status
+===========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.gmns_geo.rst b/docs/source/reference/api/pyufunc.gmns_geo.rst
@@ -1,5 +1,5 @@
-pyufunc.gmnsgeo
-===============
+pyufunc.gmns\_geo
+=================
 
 .. automodule:: pyufunc.gmns_geo
 
diff --git a/docs/source/reference/api/pyufunc.group_dt_daily.rst b/docs/source/reference/api/pyufunc.group_dt_daily.rst
@@ -1,5 +1,5 @@
-pyufunc.groupdt\_daily
-======================
+pyufunc.group\_dt\_daily
+========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.group_dt_hourly.rst b/docs/source/reference/api/pyufunc.group_dt_hourly.rst
@@ -1,5 +1,5 @@
-pyufunc.groupdt\_hourly
-=======================
+pyufunc.group\_dt\_hourly
+=========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.group_dt_minutely.rst b/docs/source/reference/api/pyufunc.group_dt_minutely.rst
@@ -1,5 +1,5 @@
-pyufunc.groupdt\_minutely
-=========================
+pyufunc.group\_dt\_minutely
+===========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.group_dt_monthly.rst b/docs/source/reference/api/pyufunc.group_dt_monthly.rst
@@ -1,5 +1,5 @@
-pyufunc.groupdt\_monthly
-========================
+pyufunc.group\_dt\_monthly
+==========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.group_dt_weekly.rst b/docs/source/reference/api/pyufunc.group_dt_weekly.rst
@@ -1,5 +1,5 @@
-pyufunc.groupdt\_weekly
-=======================
+pyufunc.group\_dt\_weekly
+=========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.group_dt_yearly.rst b/docs/source/reference/api/pyufunc.group_dt_yearly.rst
@@ -1,5 +1,5 @@
-pyufunc.groupdt\_yearly
-=======================
+pyufunc.group\_dt\_yearly
+=========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.img_resize.rst b/docs/source/reference/api/pyufunc.img_resize.rst
@@ -1,5 +1,5 @@
-pyufunc.imgresize
-=================
+pyufunc.img\_resize
+===================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.img_rotate.rst b/docs/source/reference/api/pyufunc.img_rotate.rst
@@ -1,5 +1,5 @@
-pyufunc.imgrotate
-=================
+pyufunc.img\_rotate
+===================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.img_rotate_bound.rst b/docs/source/reference/api/pyufunc.img_rotate_bound.rst
@@ -1,5 +1,5 @@
-pyufunc.imgrotate\_bound
-========================
+pyufunc.img\_rotate\_bound
+==========================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.img_show.rst b/docs/source/reference/api/pyufunc.img_show.rst
@@ -1,5 +1,5 @@
-pyufunc.imgshow
-===============
+pyufunc.img\_show
+=================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.img_translate.rst b/docs/source/reference/api/pyufunc.img_translate.rst
@@ -1,5 +1,5 @@
-pyufunc.imgtranslate
-====================
+pyufunc.img\_translate
+======================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.import_package.rst b/docs/source/reference/api/pyufunc.import_package.rst
@@ -1,5 +1,5 @@
-pyufunc.importpackage
-=====================
+pyufunc.import\_package
+=======================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.is_CV_img.rst b/docs/source/reference/api/pyufunc.is_CV_img.rst
@@ -1,5 +1,5 @@
-pyufunc.isCV\_img
-=================
+pyufunc.is\_CV\_img
+===================
 
 .. automodule:: pyufunc
 

diff --git a/docs/source/reference/api/pyufunc.is_PIL_img.rst b/docs/source/reference/api/pyufunc.is_PIL_img.rst
@@ -1,5 +1,5 @@
-pyufunc.isPIL\_img
-==================
+pyufunc.is\_PIL\_img
+====================
 
 .. automodule:: pyufunc