Updates from the package template (#177)

* Automatic package template update * Update .pre-commit-config.yaml * Update README.rst * Update README.rst * Update conf.py --------- Co-authored-by: Cadair <[email protected]> Co-authored-by: Nabil Freij <[email protected]>
sunpy · Feb 17, 2025 · 852e62c · 852e62c
1 parent b875c76
commit 852e62c
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/.cruft.json b/.cruft.json
@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sunpy/package-template",
-  "commit": "29db3569a215e43fa8c5114d3dbcb98b6a9caac0",
+  "commit": "09c4b023b973d0bbc5704326720f21d3a766bb11",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -32,7 +32,7 @@
         ".github/workflows/sub_package_update.yml"
       ],
       "_template": "https://github.com/sunpy/package-template",
-      "_commit": "29db3569a215e43fa8c5114d3dbcb98b6a9caac0"
+      "_commit": "09c4b023b973d0bbc5704326720f21d3a766bb11"
     }
   },
   "directory": null

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,7 +1,7 @@
 repos:
     # This should be before any formatting hooks like isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.9.2"
+    rev: "v0.9.6"
     hooks:
       - id: ruff
         args: ["--fix"]

diff --git a/README.rst b/README.rst
@@ -15,3 +15,10 @@
 A sunpy Fido plugin for accessing data in the Solar Orbiter Archive (SOAR).
 
 See the `documentation <https://docs.sunpy.org/projects/soar/>`_ for installation instructions, examples, how to get help and how to contribute.
+
+Usage of Generative AI
+----------------------
+
+We expect authentic engagement in our community.
+Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content.
+If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,12 @@
 
 # -- General configuration ---------------------------------------------------
 
+# Wrap large function/method signatures
+maximum_signature_line_length = 80
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
+# ones.
 extensions = [
     "sphinx_gallery.gen_gallery",
     "matplotlib.sphinxext.plot_directive",