Commits

German Larrain committed 811013b

TODO: added many; added new section 'Documentation'.

Comments (0)

Files changed (1)

 -Add to README.txt a "Contributors" section and/or a "Thanks also to" section to list the names of people who’ve helped.
 
 "Correctness"
--
+-what is 'time' for in ScreenshotRecorder.write?
+-rename demos modules in CamelCase
+-replace access to world._inner_object with its property (world.inner_object)
+-rename Simulation.get_joint as get_sim_joint
+-IROS/example4_sinusoidal_terrain: rename 'get_arm_compensation' to 'calc_arm_compensation'
+-IROS/example4_sinusoidal_terrain: extract the *_heightfield funtions
 
 Code structure (modules and packages)
 -convert sensors module into a package
--rename Simulation.get_joint as get_sim_joint
 -make JointSensor.__init__ be able to receive a Joint OR a SimulatedJoint, which
 wraps a Joint. The idea is to avoid confusing calls such as "x.get_joint().get_joint()"
 
 Tests
 -split 'tests' and what are examples of how to use external libs
 -move tests in utils.mathematical to a test file
+-extract functions from trimesh_collision: '*_heightfield', 'get_faces', 'swap_faces_indices'
+
+Documentation
+-document that 'Queue' is a wrapper of 'deque', one of the high performance
+container datatypes in built-in 'collections' module
 
 Visualization
 -create a subclass of vtkInteractorStyleTrackball (http://www.vtk.org/doc/nightly/html/classvtkInteractorStyleTrackball.html)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.