Skip to content

Commit 48f4140

Browse files
SunPyBotCadair
andauthored
Updates from package template (sunpy#918)
* Update cruft with batchpr * Update README.rst * Update README.rst --------- Co-authored-by: Stuart Mumford <stuart@cadair.com>
1 parent 30e7c50 commit 48f4140

3 files changed

Lines changed: 14 additions & 13 deletions

File tree

.cruft.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"template": "https://github.com/sunpy/package-template",
3-
"commit": "4c87aec25b842ac84ed38a609e89f145b7b0848b",
3+
"commit": "4268346dead7b529a3d53df19bcf374bb2bbef34",
44
"checkout": null,
55
"context": {
66
"cookiecutter": {
@@ -32,7 +32,7 @@
3232
".github/workflows/sub_package_update.yml"
3333
],
3434
"_template": "https://github.com/sunpy/package-template",
35-
"_commit": "4c87aec25b842ac84ed38a609e89f145b7b0848b"
35+
"_commit": "4268346dead7b529a3d53df19bcf374bb2bbef34"
3636
}
3737
},
3838
"directory": null

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
repos:
22
# This should be before any formatting hooks like isort
33
- repo: https://github.com/astral-sh/ruff-pre-commit
4-
rev: "v0.14.14"
4+
rev: "v0.15.4"
55
hooks:
66
- id: ruff
77
args: ["--fix"]
88
- repo: https://github.com/PyCQA/isort
9-
rev: 7.0.0
9+
rev: 8.0.1
1010
hooks:
1111
- id: isort
1212
exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*|ndcube/extern)$"

README.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
******
21
ndcube
3-
******
2+
======
43

54
|Latest Version| |codecov| |matrix| |Powered by NumFOCUS| |Powered by SunPy|
65

@@ -29,28 +28,30 @@ It combines data, uncertainties, units, metadata, masking, and coordinate transf
2928
It is designed to handle data of any number of dimensions and axis types (e.g. spatial, temporal, spectral, etc.) whose relationship between the array elements and the real world can be described by World Coordinate System (WCS) translations.
3029

3130
Usage of Generative AI
32-
======================
31+
----------------------
3332

3433
We expect authentic engagement in our community.
35-
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.
34+
**Do not post the output from Large Language Models or similar generative AI as code, issues or comments on GitHub or any other platform.**
3635
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.
36+
For more information see our documentation on fair and appropriate `AI usage <https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html>`__.
3737

3838
Acknowledging ndcube
39-
====================
39+
--------------------
40+
4041
If you use ``ndcube`` is your work, we kindly ask you to `acknowledge ndcube`_ in your
4142
publications and presentations.
4243

4344
.. _acknowledge ndcube: https://docs.sunpy.org/projects/ndcube/en/stable/acknowledging.html
4445

4546
Installation
46-
============
47+
------------
4748

4849
For detailed installation instructions, see the `installation guide`_ in the ndcube docs.
4950

5051
.. _installation guide: https://docs.sunpy.org/projects/ndcube/en/stable/installation.html
5152

5253
Getting Help
53-
============
54+
------------
5455

5556
For more information or to ask questions about ndcube, check out:
5657

@@ -61,7 +62,7 @@ For more information or to ask questions about ndcube, check out:
6162
.. _ndcube Chat Channel: https://app.element.io/#/room/#ndcube:openastronomy.org
6263

6364
Contributing
64-
============
65+
------------
6566

6667
If you would like to get involved, check out the `Newcomers Guide`_ section of the sunpy docs.
6768
This shows how to get setup with a "sunpy" workflow but the same applies for ndcube, you will just need to replace sunpy with ndcube.
@@ -72,7 +73,7 @@ Help is always welcome so let us know what you like to work on, or check out the
7273
.. _issues page: https://github.com/sunpy/ndcube/issues
7374

7475
Code of Conduct
75-
===============
76+
---------------
7677

7778
When you are interacting with the SunPy community you are asked to follow our `Code of Conduct`_.
7879

0 commit comments

Comments
 (0)