various updates following merging pull request

scottprahl · May 4, 2024 · 4eed41f · 4eed41f
2 parents 29d5ef6 + dc8eefa
commit 4eed41f
Show file tree

Hide file tree

Showing 15 changed files with 147 additions and 77 deletions.
diff --git a/.github/scripts/update_citation.py b/.github/scripts/update_citation.py
@@ -1,3 +1,4 @@
+"""Update the CITATION.cff file for latest version."""
 import json
 import requests
 import yaml

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,13 @@
 Changelog
 ==========
 
+0.8.1 (5/4/2024)
+-------------------
+* Implemented FF_node_polar_angle (@matt8s)
+* Added FF_node_polar_angle() example to 9-Far-field-irradiance.ipynb (@matt8s)
+* Modified _FF_polar_x to take argument kasin (@matt8s)
+* Improved configuration for ruff linting tool
+
 0.8.0 (2/13/24)
 -------------------
 * add functions for far-field irradiance (thanks @matt8s)

diff --git a/Makefile b/Makefile
@@ -20,24 +20,16 @@ lint:
 	-pylint ofiber/refraction.py
 	-pylint ofiber/__init__.py
 
-doccheck:
-	-pydocstyle ofiber/basics.py
-	-pydocstyle ofiber/cylinder_step.py
-	-pydocstyle ofiber/dispersion.py
-	-pydocstyle ofiber/graded_index.py
-	-pydocstyle ofiber/noise.py
-	-pydocstyle ofiber/planar_parabolic.py
-	-pydocstyle ofiber/planar_step.py
-	-pydocstyle ofiber/refraction.py
-	-pydocstyle ofiber/__init__.py
+ruff:
+	ruff check
 
 notecheck:
 	make clean
 	pytest --verbose tests/test_all_notebooks.py
 
 rcheck:
 	make lint
-	make doccheck
+	make ruff
 	make rstcheck
 	make html
 	check-manifest

diff --git a/docs/9-Far-field-irradiance.ipynb b/docs/9-Far-field-irradiance.ipynb
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,6 +18,7 @@
 project = 'ofiber'
 master_doc = 'index'
 
+
 def get_init_property(prop):
     """Return property from __init__.py."""
     here = os.path.abspath(os.path.dirname(__file__))
@@ -27,6 +28,7 @@ def get_init_property(prop):
         result = re.search(regex, file.read())
     return result.group(1)
 
+
 release = get_init_property("__version__")
 author = get_init_property("__author__")
 copyright = get_init_property("__copyright__")

diff --git a/ofiber/basics.py b/ofiber/basics.py
@@ -79,7 +79,7 @@ def critical_angle(n_core, n_clad):
 
     Args:
         n_core : the index of refraction of the fiber core  [--]
-        n_core : the index of refraction of the fiber cladding  [--]
+        n_clad : the index of refraction of the fiber cladding  [--]
 
     Returns:
         angle of total internal reflection [radians]
@@ -119,7 +119,8 @@ def esi_Delta(Delta, q):
     Calculate equivalent step index (esi) Delta for a graded-index fiber.
 
     Args:
-        Delta :  relative refractive index     [-]
+        Delta :  relative refractive index         [-]
+        q :      parameter for graded index fiber  [-]
 
     Returns:
         equivalent relative refractive index   [-]