From 79cae51156ad3af77c775f4e2be652b2b387d46f Mon Sep 17 00:00:00 2001
From: Richard Berger <richard.berger@temple.edu>
Date: Wed, 15 Mar 2017 22:20:30 -0400
Subject: [PATCH] Document property 'uses_exceptions' of Python interface

---
 python/lammps.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/python/lammps.py b/python/lammps.py
index 0581b475a4..a36abb87e8 100644
--- a/python/lammps.py
+++ b/python/lammps.py
@@ -379,10 +379,10 @@ class lammps(object):
     type_lmp[:] = type
     self.lib.lammps_create_atoms(self.lmp,n,id_lmp,type_lmp,x,v,image_lmp,shrinkexceed)
 
-  # document this?
-    
+
   @property
   def uses_exceptions(self):
+    """ Return whether the LAMMPS shared library was compiled with C++ exceptions handling enabled """
     try:
       if self.lib.lammps_has_error:
         return True
-- 
GitLab