Rearrange types in docs, touch up FaceSpec doc-comment and link from to target constructor for more details

TomHall2020 · TomHall2020 · commit a4bd13281cb0 · 2024-03-18T07:43:06.000Z
diff --git a/archeryutils/targets.py b/archeryutils/targets.py
@@ -26,8 +26,7 @@
 ]
 
 # TypeAlias (annotate explicitly in py3.10+)
-#: A mapping of a target ring diameter to the score for hitting that ring.
-#: Typically ordered from smallest to largest rings but this is not necessary.
+#: A mapping of a target ring diameter to the score for that ring.
 FaceSpec = Mapping[float, int]
 
 _rnd6 = partial(round, ndigits=6)
diff --git a/docs/api/archeryutils.types.rst b/docs/api/archeryutils.types.rst
@@ -5,4 +5,4 @@ Types
 
 .. autodata:: archeryutils.targets.FaceSpec
 
-
+See :py:meth:`~archeryutils.Target.from_face_spec` for more details what targets can be modeled with this.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -4,14 +4,14 @@ API Documentation
 =================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
-   archeryutils.baseclasses
+   archeryutils.types
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
-   archeryutils.types
+   archeryutils.baseclasses
 
 .. toctree::
    :maxdepth: 3

Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,7 @@`
`26`	`26`	`]`
`27`	`27`
`28`	`28`	`# TypeAlias (annotate explicitly in py3.10+)`
`29`		`-#: A mapping of a target ring diameter to the score for hitting that ring.`
`30`		`-#: Typically ordered from smallest to largest rings but this is not necessary.`
	`29`	`+#: A mapping of a target ring diameter to the score for that ring.`
`31`	`30`	`FaceSpec = Mapping[float, int]`
`32`	`31`
`33`	`32`	`_rnd6 = partial(round, ndigits=6)`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ Types`
`5`	`5`
`6`	`6`	`.. autodata:: archeryutils.targets.FaceSpec`
`7`	`7`
`8`		`-`
	`8`	+See :py:meth:`~archeryutils.Target.from_face_spec` for more details what targets can be modeled with this.