Skip to content

Commit 1ce4772

Browse files
reint-fischerreint-fischer
authored andcommitted
address suggestions from github review
1 parent 3bbf6f1 commit 1ce4772

File tree

4 files changed

+15
-13
lines changed

4 files changed

+15
-13
lines changed

docs/_autoapi_templates/python/class.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
{# Adapted from sphinx-autoapi https://github.com/readthedocs/sphinx-autoapi #}
12
{% if obj.display %}
23
{% if is_own_page %}
34
{{ obj.id }}

docs/_autoapi_templates/python/module.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
{# Adapted from sphinx-autoapi https://github.com/readthedocs/sphinx-autoapi #}
12
{% if obj.display %}
23
{% if is_own_page %}
34
{{ obj.id }}

src/parcels/__init__.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@
99

1010
import warnings as _stdlib_warnings
1111

12-
from parcels._core.basegrid import BaseGrid
13-
from parcels._core.field import Field, VectorField
1412
from parcels._core.fieldset import FieldSet
13+
from parcels._core.particleset import ParticleSet
1514
from parcels._core.kernel import Kernel
15+
from parcels._core.particlefile import ParticleFile
1616
from parcels._core.particle import (
17-
KernelParticle, # ? remove?
17+
Variable,
1818
Particle,
1919
ParticleClass,
20-
Variable,
20+
KernelParticle, # ? remove?
2121
)
22-
from parcels._core.particlefile import ParticleFile
23-
from parcels._core.particleset import ParticleSet
22+
from parcels._core.field import Field, VectorField
23+
from parcels._core.basegrid import BaseGrid
2424
from parcels._core.uxgrid import UxGrid
2525
from parcels._core.xgrid import XGrid
2626

@@ -52,16 +52,16 @@
5252

5353
__all__ = [ # noqa: RUF022
5454
# Core classes
55-
"BaseGrid",
56-
"Field",
57-
"VectorField",
5855
"FieldSet",
56+
"ParticleSet",
5957
"Kernel",
58+
"ParticleFile",
59+
"Variable",
6060
"Particle",
6161
"ParticleClass",
62-
"Variable",
63-
"ParticleFile",
64-
"ParticleSet",
62+
"Field",
63+
"VectorField",
64+
"BaseGrid",
6565
"UxGrid",
6666
"XGrid",
6767
# Converters

src/parcels/_core/basegrid.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class GridType(IntEnum):
2222

2323

2424
class BaseGrid(ABC):
25-
"""Docstring for Basegrid class"""
25+
"""Define a base class for parcels X and Ux grids with common methods and properties"""
2626

2727
@abstractmethod
2828
def search(self, z: float, y: float, x: float, ei=None) -> dict[str, tuple[int, float | np.ndarray]]:

0 commit comments

Comments
 (0)