DOC: Fixed PR09 error in pandas.testing.assert_series_equal

[tolhassianipar]

• closes Fix PR09 error in pandas.testing.assert_series_equal pandanistas/pandanistas_sprint_ui2020#15
• tests added / passed
• passes black pandas
• passes git diff upstream/master -u -- "*.py" | flake8 --diff
• whatsnew entry

Output of python scripts/validate_docstrings.py pandas.HDFStore.put:

################################################################################
####################### Docstring (pandas.HDFStore.put)  #######################
################################################################################

Store object in HDFStore.

Parameters
----------
key : str
value : {Series, DataFrame}
format : 'fixed(f)|table(t)', default is 'fixed'
    fixed(f) : Fixed format
               Fast writing/reading. Not-appendable, nor searchable.
    table(t) : Table format
               Write as a PyTables Table structure which may perform
               worse but allow more flexible operations like searching
               / selecting subsets of the data.
append   : bool, default False
    This will force Table format, append the input data to the
    existing.
data_columns : list, default None
    List of columns to create as data columns, or True to
    use all columns. See `here
    <https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#query-via-data-columns>`__.
encoding : str, default None
    Provide an encoding for strings.
dropna   : bool, default False, do not write an ALL nan row to
    The store settable by the option 'io.hdf.dropna_table'.

################################################################################
################################## Validation ##################################
################################################################################

8 Errors found:
        No extended summary found
        Parameters {'min_itemsize', 'index', 'complevel', 'errors', 'complib', 'append', 'nan_rep'} not documented
        Unknown parameters {'dropna  ', 'append  '}
        Parameter "key" has no description
        Parameter "value" has no description
        Parameter "format" description should start with a capital letter
        See Also section not found
        No examples section found

(pandas-dev) D:\Keluarga\Tolhas\Kuliah\Semester 4\DSC Pandas\pandas-tolhassianipar>python scripts/validate_docstrings.py pandas.HDFStore.put

################################################################################
####################### Docstring (pandas.HDFStore.put)  #######################
################################################################################

Store object in HDFStore.

Parameters
----------
key : str
value : {Series, DataFrame}
format : 'fixed(f)|table(t)', default is 'fixed'
    fixed(f) : Fixed format
               Fast writing/reading. Not-appendable, nor searchable.
    table(t) : Table format
               Write as a PyTables Table structure which may perform
               worse but allow more flexible operations like searching
               / selecting subsets of the data.
append   : bool, default False
    This will force Table format, append the input data to the
    existing.
data_columns : list, default None
    List of columns to create as data columns, or True to
    use all columns. See `here
    <https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#query-via-data-columns>`__.
encoding : str, default None
    Provide an encoding for strings.
dropna   : bool, default False, do not write an ALL nan row to
    The store settable by the option 'io.hdf.dropna_table'.

################################################################################
################################## Validation ##################################
################################################################################

8 Errors found:
        No extended summary found
        Parameters {'errors', 'index', 'nan_rep', 'append', 'min_itemsize', 'complevel', 'complib'} not documented
        Unknown parameters {'append  ', 'dropna  '}
        Parameter "key" has no description
        Parameter "value" has no description
        Parameter "format" description should start with a capital letter
        See Also section not found
        No examples section found

[WillAyd]

Thanks @tolhassianipar

[tolhassianipar]

Happy to join, thanks too :)