Add extended summary and see also, amend parameters

Author: m-dz

pandas/core/frame.py

@@ -1494,70 +1494,80 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
                quotechar='"', line_terminator='\n', chunksize=None,
                tupleize_cols=None, date_format=None, doublequote=True,
                escapechar=None, decimal='.'):
-        r"""Write DataFrame to a comma-separated values (csv) file
+        """Write a DataFrame to a comma-separated values (CSV) file.
+
+        Write a DataFrame to a comma-separated values (CSV) file with an user
+        specified format (e.g. a separator, missing values representation,
+        quoting etc.), header and index specification and possible compression.
 
         Parameters
         ----------
-        path_or_buf : string or file handle, default None
+        path_or_buf : str or file handle, default None
             File path or object, if None is provided the result is returned as
             a string.
-        sep : character, default ','
+        sep : str (length 1), default ','
             Field delimiter for the output file.
-        na_rep : string, default ''
-            Missing data representation
-        float_format : string, default None
-            Format string for floating point numbers
+        na_rep : str, default ''
+            Missing data representation.
+        float_format : str, default None
+            Format string for floating point numbers.
         columns : sequence, optional
-            Columns to write
-        header : boolean or list of string, default True
+            Columns to write.
+        header : bool or list of str, default True
             Write out the column names. If a list of strings is given it is
-            assumed to be aliases for the column names
-        index : boolean, default True
-            Write row names (index)
-        index_label : string or sequence, or False, default None
+            assumed to be aliases for the column names.
+        index : bool, default True
+            Write row names (index).
+        index_label : str or sequence, or False, default None
             Column label for index column(s) if desired. If None is given, and
-            `header` and `index` are True, then the index names are used. A
-            sequence should be given if the DataFrame uses MultiIndex.  If
-            False do not print fields for index names. Use index_label=False
-            for easier importing in R
-        mode : str
-            Python write mode, default 'w'
-        encoding : string, optional
+            `header` and `index` are `True`, then the index names are used. A
+            sequence should be given if the DataFrame uses MultiIndex. If
+            `False` do not print fields for index names.
+            Use `index_label=False` for easier importing in R.
+        mode : str, default 'w'
+            Python write mode.
+        encoding : str, optional
             A string representing the encoding to use in the output file,
             defaults to 'ascii' on Python 2 and 'utf-8' on Python 3.
-        compression : string, optional
-            a string representing the compression to use in the output file,
-            allowed values are 'gzip', 'bz2', 'xz',
-            only used when the first argument is a filename
-        line_terminator : string, default ``'\n'``
+        compression : str, optional
+            A string representing the compression to use in the output file,
+            allowed values are 'gzip', 'bz2', 'xz', only used when the first
+            argument is a filename.
+        line_terminator : str, default ``'\n'``
             The newline character or character sequence to use in the output
             file
         quoting : optional constant from csv module
             defaults to csv.QUOTE_MINIMAL. If you have set a `float_format`
             then floats are converted to strings and thus csv.QUOTE_NONNUMERIC
             will treat them as non-numeric
-        quotechar : string (length 1), default '\"'
+        quotechar : str (length 1), default '\"'
             character used to quote fields
-        doublequote : boolean, default True
+        doublequote : bool, default True
             Control quoting of `quotechar` inside a field
-        escapechar : string (length 1), default None
+        escapechar : str (length 1), default None
             character used to escape `sep` and `quotechar` when appropriate
         chunksize : int or None
             rows to write at a time
-        tupleize_cols : boolean, default False
+        tupleize_cols : bool, default False
             .. deprecated:: 0.21.0
                This argument will be removed and will always write each row
                of the multi-index as a separate row in the CSV file.
 
-            Write MultiIndex columns as a list of tuples (if True) or in
+            Write MultiIndex columns as a list of tuples (if `True`) or in
             the new, expanded format, where each MultiIndex column is a row
-            in the CSV (if False).
-        date_format : string, default None
+            in the CSV (if `False`).
+        date_format : str, default None
             Format string for datetime objects
-        decimal: string, default '.'
+        decimal: str, default '.'
             Character recognized as decimal separator. E.g. use ',' for
             European data
 
+        See Also
+        --------
+        pandas.Series.to_csv : Write a Series to a comma-separated values (CSV)
+        file.
+        pandas.read_csv : Read a comma-separated values (CSV) file into
+        a DataFrame.
         """
 
         if tupleize_cols is not None: