|  | 
| 
			 
			#7  
			
			
			
			
			
		 | |||
| 
 | |||
| 
			
			I mentioned to farshizzo once before that there were many functions that did not have docstrings.  My own opinion is that anything that is not intended for outside callers should have a brief comment (deprecated, internal helper function, etc.), and anything that is intended for outside callers should have a complete and useful python docstring.  Even if almost nobody using Vizard knows the python help() command, it will still be there in the *.py files to read. There's some extra work involved in good docstrings; a one-liner is not usually sufficient. However, you might find a way to automatically include the docstrings into the online help files as a preface to any additional detail there. 
				__________________ -- [ e d h a l l e y ] I'm just a user, not a representative of WorldViz. Hope I've been helpful. | 
| Thread Tools | |
| Display Modes | Rate This Thread | 
| 
 | 
 |