Commits

German Larrain committed e8b724b

collision.adapters: added docstring for module, OdeEngine.is_ray, Space, OdeGeom.

  • Participants
  • Parent commits 7167a96

Comments (0)

Files changed (1)

ars/model/collision/adapters.py

+"""Classes and functions to interface with the collision library
+included in ODE.
+
+"""
 from abc import ABCMeta
 
 import ode
 
 	@staticmethod
 	def is_ray(geom):
-		"""Is `geom` a ray?"""
+		"""Return whether ``geom`` is a :class:`ode.GeomRay` object or not.
+
+		:param geom:
+		:type geom: :class:`ode.GeomObject`
+		:return: True if ``geom`` is an instance of :class:`ode.GeomRay`
+		:rtype: bool
+
+		"""
 		return isinstance(geom, ode.GeomRay)
 
 	@staticmethod
 
 
 class Space(base.Space):
+
+	"""Adapter to :class:`ode.SimpleSpace`."""
+
 	def __init__(self):
 		self._inner_object = ode_objects_factories.create_ode_simple_space()
 
 
 class OdeGeom(base.Geom):
 
+	"""Abstract class, sort of equivalent to :class:`ode.GeomObject`."""
+
 	def attach_body(self, body):
 		super(OdeGeom, self).attach_body(body)
 		self._inner_object.setBody(body.inner_object)