Skip to content

Commit c05f4f6

Browse files
reint-fischerreint-fischer
authored andcommitted
fix some docs warnings
1 parent 7507bc1 commit c05f4f6

2 files changed

Lines changed: 17 additions & 13 deletions

File tree

docs/development/policies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We accept that Parcels developers have their own motivation for using (or not us
1010
1111
Remember that reviews are done by human maintainers - asking us to review code that an AI wrote but you don't understand isn't kind to these maintainers.
1212

13-
The [CLAUDE.md](/CLAUDE.md) file in the repository has additional instructions for AI agents to follow when contributing to Parcels.
13+
The [CLAUDE.md](https://github.com/Parcels-code/Parcels/blob/HEAD/CLAUDE.md) file in the repository has additional instructions for AI agents to follow when contributing to Parcels.
1414

1515
## Versioning
1616

src/parcels/_core/field.py

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,30 +54,34 @@ class Field:
5454
"""The Field class that holds scalar field data.
5555
The `Field` object is a wrapper around a xarray.DataArray or uxarray.UxDataArray object.
5656
Additionally, it holds a dynamic Callable procedure that is used to interpolate the field data.
57-
During initialization, the user is required to supply a custom interpolation method that is used to interpolate the field data,
58-
so long as the interpolation method has the correct signature.
57+
During initialization, the user is required to supply a custom interpolation method that is used
58+
to interpolate the field data, so long as the interpolation method has the correct signature.
5959
6060
Notes
6161
-----
6262
The xarray.DataArray or uxarray.UxDataArray object contains the field data and metadata.
63-
* dims: (time, [nz1 | nz], [face_lat | node_lat | edge_lat], [face_lon | node_lon | edge_lon])
64-
* attrs: (location, mesh, mesh)
6563
66-
When using a xarray.DataArray object,
64+
* dims: (time, [nz1 | nz], [face_lat | node_lat | edge_lat], [face_lon | node_lon | edge_lon])
65+
* attrs: (location, mesh, mesh)
66+
67+
When using a xarray.DataArray object:
68+
6769
* The xarray.DataArray object must have the "location" and "mesh" attributes set.
68-
* The "location" attribute must be set to one of the following to define which pairing of points a field is associated with.
69-
* "node"
70-
* "face"
71-
* "x_edge"
72-
* "y_edge"
73-
* For an A-Grid, the "location" attribute must be set to / is assumed to be "node" (node_lat,node_lon).
70+
* The "location" attribute must be set to one of the following to define which pairing of points a field is associated with:
71+
* "node"
72+
* "face"
73+
* "x_edge"
74+
* "y_edge"
75+
76+
* For an A-Grid, the "location" attribute must be set to / is assumed to be "node" (node_lat,node_lon).
7477
* For a C-Grid, the "location" setting for a field has the following interpretation:
7578
* "node" ~> the field is associated with the vorticity points (node_lat, node_lon)
7679
* "face" ~> the field is associated with the tracer points (face_lat, face_lon)
7780
* "x_edge" ~> the field is associated with the u-velocity points (face_lat, node_lon)
7881
* "y_edge" ~> the field is associated with the v-velocity points (node_lat, face_lon)
7982
80-
When using a uxarray.UxDataArray object,
83+
When using a uxarray.UxDataArray object:
84+
8185
* The uxarray.UxDataArray.UxGrid object must have the "Conventions" attribute set to "UGRID-1.0"
8286
and the uxarray.UxDataArray object must comply with the UGRID conventions.
8387
See https://ugrid-conventions.github.io/ugrid-conventions/ for more information.

0 commit comments

Comments
 (0)