Commits

German Larrain committed 0cb25d6

no code changes: just fixes and improvements to docstrings.

  • Participants
  • Parent commits 99ae877

Comments (0)

Files changed (4)

File ars/graphics/adapters.py

 
 	def write(self, index=1, time=None):
 		"""
+
 		.. note::
 		   Image files format is PNG, and extension is ``.png``.
 

File ars/model/simulator/__init__.py

 		If its name equals an already registered key, it will be modified
 		using its string representation, for example:
 
-		>>> sim.add_object(sim_object)
+		>>> add_object(sim_object)
 		sphere/<ars.model.simulator.SimulatedBody object at 0x3a4bed0>
 
 		:param sim_object: object to add

File ars/utils/version.py

 	>>> get_version(version=(0, 4, 0, 'alpha', 0), length='short')
 	0.4
 
-	based on: ``django.utils.version`` @ commit 9098504.
-	See its license in docs/Django BSD-LICENSE.txt
+	Based on: ``django.utils.version`` @ commit 9098504.
+	Django's license is included at docs/Django BSD-LICENSE.txt
 
 	"""
 	assert length in ('short', 'medium', 'full')
 	>> get_hg_tip_timestamp()
 	'20130328021918'
 
-	Based on: ``django.utils.get_git_changeset`` @ 1.5.0
-	(see its license in docs/Django BSD-LICENSE.txt) and
+	Based on: ``django.utils.get_git_changeset`` @ commit 9098504, and
 	http://hgbook.red-bean.com/read/customizing-the-output-of-mercurial.html
 
+	Django's license is included at docs/Django BSD-LICENSE.txt
+
 	"""
 	# Timestamp conversion process:
 	# '1364437158.010800'

File demos/sensors/joint_power1.py

 
 	"""Simulation of a virtual power sensor attached to a joint (``r2``).
 
-	This joint is not powered but because friction is considered
-	an external	torque is applied at each simulation step
-	(see :meth:`apply_friction`). Because it is a friction torque,
-	the applied power is negative.
+	This joint is not powered. However, because friction is considered,
+	an external torque is applied at each simulation step
+	(see :meth:`apply_friction`). Due to the fact it is a friction torque,
+	**the applied power is negative**.
 
 	The laser is positioned at :attr:`RAY_POS` and its detection range
 	is determined by :attr:`RAY_LENGTH`. The default orientation