Merge pull request #6 from Watz-Inc/misc

Doc 404, doc outdated header, docstrings

docs/assets/404.html

@@ -0,0 +1,12 @@
+<!-- MANUAL: add this directly to the docs-site branch where its needed -->
+<!-- This currently always redirects to the latest version which isn't ideal, but should be sorted eventually as the issue is recent -->
+<!-- (the solution in the issue hardcodes the versions which isn't worth it) -->
+<!-- https://github.com/jimporter/mike/issues/72 -->
+
+<script>
+  const defaultVersion = "latest";
+  const basePath = "watz-py";
+  const targetRedirectPath = "404"; // path to redirect to, relative to basePath
+
+  window.location.href = `/${basePath}/${defaultVersion}/${targetRedirectPath}`;
+</script>

docs/overrides/main.html

@@ -0,0 +1,6 @@
+{% extends "base.html" %} {% block outdated %} You're not viewing the latest
+version.
+<a href="{{ '../' ~ base_url }}">
+  <strong>Click here to go to latest.</strong>
+</a>
+{% endblock %}

mkdocs.yml

@@ -7,6 +7,7 @@ extra_css:
 
 theme:
   name: "material"
+  custom_dir: docs/overrides
   features:
     - navigation.instant
     - navigation.instant.progress

watz.code-workspace

@@ -47,6 +47,7 @@
     "files.exclude": {
       "**/.venv/**": true,
       "**/venv/**": true,
+      "**/.nox/**": true,
       "**/coverage": true,
       "**/htmlcov": true,
       "**/__pycache__": true,
@@ -59,6 +60,7 @@
     "files.watcherExclude": {
       "**/.venv/**": true,
       "**/venv/**": true,
+      "**/.nox/**": true,
       "**/coverage": true,
       "**/htmlcov": true,
       "**/__pycache__": true,

watz/client.py

@@ -73,7 +73,7 @@ def trace_list(self, nids: tp.Iterable[str]) -> RespTraceList:
         """Retrieves the trace metadata for the requested nodes.
 
         Args:
-            nids (tp.Iterable[str]): The node ids to retrieve trace metadata for.
+            nids (list[str]): The node ids to retrieve trace metadata for.
 
         Returns:
             RespTraceList
@@ -89,7 +89,7 @@ def trace_data(self, traces: tp.Mapping[str, tp.Iterable[str]]) -> RespTraceData
         """Retrieves the trace data for the request traces.
 
         Args:
-            traces (tp.Mapping[str, tp.Iterable[str]]): A dict of node ids to a list of trace identifiers for each respective node.
+            traces (dict[str, list[str]]): A dict of node ids to a list of trace identifiers for each respective node.
 
         Returns:
             RespTraceData
@@ -109,7 +109,7 @@ def create_nodes(
         """Creates new nodes.
 
         Args:
-            nodes (tp.Iterable[tp.Union[CreateActivityNode, CreateUserNode]]): The nodes to create.
+            nodes (list[tp.Union[CreateActivityNode, CreateUserNode]]): The nodes to create.
 
         Returns:
             RespCreateNodes
@@ -127,7 +127,7 @@ def create_traces(self, traces: tp.Mapping[str, tp.Iterable[CreateTrace]]) -> Re
         """Creates new traces.
 
         Args:
-            traces (tp.Mapping[str, tp.Iterable[CreateTrace]]): A dict of node ids to a list of traces to create for each respective node.
+            traces (dict[str, tp.Iterable[CreateTrace]]): A dict of node ids to a list of traces to create for each respective node.
 
         Returns:
             RespCreateTraces