Skip to content

Commit

Permalink
Fix Halo docstrings so Firedrake docs link properly
Browse files Browse the repository at this point in the history
  • Loading branch information
JDBetteridge committed Feb 3, 2023
1 parent 2c2c419 commit 3748115
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions pyop2/types/halo.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

class Halo(abc.ABC):

"""A description of a halo associated with a :class:`Set`.
"""A description of a halo associated with a :class:`pyop2.types.set.Set`.
The halo object describes which :class:`Set` elements are sent
where, and which :class:`Set` elements are received from where.
The halo object describes which :class:`pyop2.types.set.Set` elements are sent
where, and which :class:`pyop2.types.set.Set` elements are received from where.
"""

@abc.abstractproperty
Expand All @@ -23,7 +23,7 @@ def local_to_global_numbering(self):
def global_to_local_begin(self, dat, insert_mode):
"""Begin an exchange from global (assembled) to local (ghosted) representation.
:arg dat: The :class:`Dat` to exchange.
:arg dat: The :class:`pyop2.types.dat.Dat` to exchange.
:arg insert_mode: The insertion mode.
"""
pass
Expand All @@ -32,7 +32,7 @@ def global_to_local_begin(self, dat, insert_mode):
def global_to_local_end(self, dat, insert_mode):
"""Finish an exchange from global (assembled) to local (ghosted) representation.
:arg dat: The :class:`Dat` to exchange.
:arg dat: The :class:`pyop2.types.dat.Dat` to exchange.
:arg insert_mode: The insertion mode.
"""
pass
Expand All @@ -41,7 +41,7 @@ def global_to_local_end(self, dat, insert_mode):
def local_to_global_begin(self, dat, insert_mode):
"""Begin an exchange from local (ghosted) to global (assembled) representation.
:arg dat: The :class:`Dat` to exchange.
:arg dat: The :class:`pyop2.types.dat.Dat` to exchange.
:arg insert_mode: The insertion mode.
"""
pass
Expand All @@ -50,7 +50,7 @@ def local_to_global_begin(self, dat, insert_mode):
def local_to_global_end(self, dat, insert_mode):
"""Finish an exchange from local (ghosted) to global (assembled) representation.
:arg dat: The :class:`Dat` to exchange.
:arg dat: The :class:`pyop2.types.dat.Dat` to exchange.
:arg insert_mode: The insertion mode.
"""
pass

0 comments on commit 3748115

Please sign in to comment.