Organise documentation
This commit is contained in:
		
							
								
								
									
										10
									
								
								docs/api.rst
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								docs/api.rst
									
									
									
									
									
								
							@@ -140,12 +140,12 @@ to handle it, which defaults to print a traceback and ignoring the exception.
 | 
			
		||||
    printed to stderr and the exception is ignored. If you want to
 | 
			
		||||
    change this behaviour and handle the exception for whatever reason
 | 
			
		||||
    yourself, this event can be overridden. Which, when done, will
 | 
			
		||||
    supress the default action of printing the traceback.
 | 
			
		||||
    suppress the default action of printing the traceback.
 | 
			
		||||
 | 
			
		||||
    The information of the exception rasied and the exception itself can
 | 
			
		||||
    be retreived with a standard call to ``sys.exc_info()``.
 | 
			
		||||
    The information of the exception raised and the exception itself can
 | 
			
		||||
    be retrieved with a standard call to ``sys.exc_info()``.
 | 
			
		||||
 | 
			
		||||
    If you want exception to propogate out of the :class:`Client` class
 | 
			
		||||
    If you want exception to propagate out of the :class:`Client` class
 | 
			
		||||
    you can define an ``on_error`` handler consisting of a single empty
 | 
			
		||||
    ``raise`` statement.  Exceptions raised by ``on_error`` will not be
 | 
			
		||||
    handled in any way by :class:`Client`.
 | 
			
		||||
@@ -154,7 +154,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
 | 
			
		||||
    :param args: The positional arguments for the event that raised the
 | 
			
		||||
        exception.
 | 
			
		||||
    :param kwargs: The keyword arguments for the event that raised the
 | 
			
		||||
        execption.
 | 
			
		||||
        exception.
 | 
			
		||||
 | 
			
		||||
.. function:: on_socket_raw_receive(msg)
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user