doc: docstring to numpy style

Author: Tieqiong

src/diffpy/pdffit2/pdffit.py

@@ -104,6 +104,15 @@ def _convertCallable(var):
 
 
 class PdfFit(object):
+    """Class for PdfFit.
+
+    Attributes
+    ----------
+    stru_files : list
+        The list to store structure files.
+    data_files : list
+        The list to store data files.
+    """
 
     # constants and enumerators from pdffit.h:
     # selection of all atoms
@@ -1251,29 +1260,21 @@ def rcut():
 
     # End refinable variables.
 
-    def __init__(self, intro=True):
+    def __init__(self, create_intro=True):
         """Initialize the Pdffit class, create a new PdfFit object.
 
         Parameters
         ----------
-        intro : bool, optional
-            If True, display an introduction message. Default is True.
-
-        Attributes
-        ----------
-        stru_files : list
-            A list to store structure files.
-        data_files : list
-            A list to store data files.
-        _handle : PyCapsule
-            A python capsules to retrieve the printer to PdfFit object.
+        create_intro : bool, optional
+            The flag to control the display of an introduction message.
+            If True, display an introduction message, else not. Default is True.
         """
 
         self.stru_files = []
         self.data_files = []
 
         self._handle = pdffit2.create()
-        if intro:
+        if create_intro:
             self.intro()
         return
 

tests/test_pdffit.py

@@ -750,16 +750,10 @@ def test_occ(self):
 
     def test___init__(self):
         """Check PdfFit.__init__()"""
-        P = PdfFit()
-        self.assertEqual([], P.stru_files)
-        self.assertEqual([], P.data_files)
+        output_true = self.capture_output(PdfFit, create_intro=True).strip()
+        output_false = self.capture_output(PdfFit, create_intro=False).strip()
 
-        output_true = self.capture_output(PdfFit, intro=True).strip()
-        output_false = self.capture_output(PdfFit, intro=False).strip()
-
-        import diffpy.pdffit2.pdffit as pdffit
-
-        self.assertEqual(len(output_true), len(pdffit.__intro_message__.strip()))
+        self.assertGreater(len(output_true), 0)
         self.assertEqual(len(output_false), 0)
 
         return