version bump and docs fix

fetch_data decorated funcs were not correctly autogenerating docs
halworsen · Mar 9, 2024 · d3fe516 · d3fe516
1 parent ee53cb9
commit d3fe516
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,10 +2,20 @@
 
 Backwards compatibility is not guaranteed in versions <1.0.0.
 
+## v2.1.0
+
+* Added support for the new phase data exposed by the API. See
+  [the official v2 API docs](https://www.fflogs.com/v2-api-docs/ff/encounterphases.doc.html)
+  for more information
+  * Phase information is exposed at the fight level in the client, *not* at the report level
+* Fix quotes not being properly escaped in query filters
+
 ## v2.0.2
+
 * [fix zone_rankings giving up on exception (#1)](https://github.com/halworsen/fflogsapi/commit/b428f992f623d2a313da078409a3f1d9960afe3a)
 
 ## v2.0.1
+
 * Stricter pinning of dependencies
   * urllib3 has been pinned to ~=1.26.14 to prevent breaking interop between requests >=2.29.0 and urllib3 >=2.0.0
 * Fix docs dependencies

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -260,6 +260,11 @@ Dataclasses
   :undoc-members:
   :private-members:
 
+.. autoclass:: FFLogsPhase
+  :members:
+  :undoc-members:
+  :private-members:
+
 Pagination
 ----------
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -14,8 +14,8 @@
 project = 'fflogsapi'
 copyright = '2023, Markus Wang Halvorsen'
 author = 'Markus Wang Halvorsen'
-release = '2.0.2'
-version = '2.0.2'
+release = '2.1.0'
+version = '2.1.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/source/get_started.rst b/docs/source/get_started.rst
@@ -19,11 +19,11 @@ Getting API credentials
 -----------------------
 
 fflogsapi requires you to create an API client before use. For information on how to get a client ID and client secret,
-read `the official FF Logs API documentation <https://articles.fflogs.com/help/api-documentation>`_.
+read `the official FF Logs API documentation <https://www.archon.gg/ffxiv/articles/help/api-documentation>`_.
 
 .. note::
     If you're looking to access private information, you must use fflogsapi in user mode,
-    which may require special setup when creating the API client. For more information, see :doc:`user_flow`.
+    which requires special setup when creating the API client. For more information, see :doc:`user_flow`.
 
 Using the client
 ----------------

diff --git a/fflogsapi/util/decorators.py b/fflogsapi/util/decorators.py
@@ -1,3 +1,6 @@
+from functools import wraps
+
+
 def fetch_data(*keys):
     '''
     Decorator that queries and stores the given `key` in a class's `_data` dictionary.
@@ -10,6 +13,7 @@ def fetch_data(*keys):
         `key`: The key to query and store.
     '''
     def decorator(func):
+        @wraps(func)
         def ensured(*args, **kwargs):
             self = args[0]
             for key in keys:

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = 'fflogsapi'
-version = '2.0.2'
+version = '2.1.0'
 description = 'Python client for the FF Logs v2 API'
 readme = 'README.md'
 authors = [