Merge branch 'develop' into synpy-1575-fileview-updates

Author: BryanFauble

Diff for: .github/pull_request_template.md

@@ -0,0 +1,25 @@
+# **Problem:**
+
+- Describe the specific technical problem that this PR solves.
+- Include  details such as:
+    - How you reproduced the problem
+    - What code is affected
+    - Any relevant background information
+
+# **Solution:**
+
+- Describe the specific technical solution that this PR provides.
+- Include details such as:
+    - How you debugged the problem
+    - Why you chose this solution
+    - Does the solution make any impact beyond the immediate problem
+    - Any necessary technical debt incurred
+    - Any important design decisions/links to design documentation (if applicable)
+
+# **Testing:**
+
+- Describe any testing that was performed to validate the solution.
+- Include details such as:
+    - How you tested the solution
+    - Any relevant test results (Do not include any test results that may contain sensitive information)
+    - Any automated tests that were added to the codebase

Diff for: .readthedocs.yaml

@@ -8,7 +8,8 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
+    # alias for the latest 3.x version available on Read the Docs
+    python: "3"
 
 mkdocs:
   configuration: mkdocs.yml
@@ -17,3 +18,8 @@ mkdocs:
 python:
   install:
   - requirements: docs/requirements.txt
+
+# See https://docs.readthedocs.com/platform/stable/config-file/v2.html#search for more options
+search:
+  ranking:
+    reference/*: -1

Diff for: docs/guides/data_storage.md

@@ -104,7 +104,7 @@ Migrating a Synapse project or folder programmatically is a two step process.
 
 First ensure that you know the id of the storage location you want to migrate to. More info on storage locations can be found above and [here](https://help.synapse.org/docs/Custom-Storage-Locations.2048327803.html).
 
-Once the storage location is known, the first step to migrate the project or folder is to create a migratable index of its contents using the [index_files_for_migration](synapseutils.migrate_functions.index_files_for_migration) function, e.g.
+Once the storage location is known, the first step to migrate the project or folder is to create a migratable index of its contents using the [index_files_for_migration][synapseutils.migrate_functions.index_files_for_migration] function, e.g.
 
 When specifying the `.db` file for the migratable indexes you need to specify a `.db` file that does not already exist for another synapse project or folder on disk. It is the best practice to specify a unique name for the file by including the synapse id in the name of the file, or other unique identifier.
 
@@ -134,9 +134,9 @@ result = synapseutils.index_files_for_migration(
 )
 ```
 
-If called on a container (e.g. a Project or Folder) the *index_files_for_migration* function will recursively index all of the children of that container (including its subfolders). Once the entity has been indexed you can optionally programmatically inspect the the contents of the index or output its contents to a csv file in order to manually inspect it using the [available methods](synapseutils.html#synapseutils.migrate_functions.MigrationResult) on the returned result object.
+If called on a container (e.g. a Project or Folder) the *index_files_for_migration* function will recursively index all of the children of that container (including its subfolders). Once the entity has been indexed you can optionally programmatically inspect the the contents of the index or output its contents to a csv file in order to manually inspect it using the [available methods][synapseutils.migrate_functions.MigrationResult] on the returned result object.
 
-The next step to trigger the migration from the indexed files is using the [migrate_indexed_files](synapseutils.html#synapseutils.migrate_functions.migrate_indexed_files) function, e.g.
+The next step to trigger the migration from the indexed files is using the [migrate_indexed_files][synapseutils.migrate_functions.migrate_indexed_files] function, e.g.
 
 ```python
 result = synapseutils.migrate_indexed_files(

Diff for: tests/integration/conftest.py

@@ -51,7 +51,7 @@ def pytest_collection_modifyitems(items) -> None:
 
 
 @pytest_asyncio.fixture(loop_scope="session", scope="session")
-async def syn(request) -> Synapse:
+def syn(request) -> Synapse:
     """
     Create a logged in Synapse instance that can be shared by all tests in the session.
     If xdist is being used a syn is created for each worker node.

Diff for: tests/unit/synapseclient/models/unit_test_table.py

@@ -1,4 +1,5 @@
 """Tests for the Table class."""
+
 import pytest
 
 from synapseclient import Synapse