BrandonFors/pandas-github-issues huggingface dataset:
DOC: update the pandas.Series.tail docstring
State: closed

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

- [X] PR title is "DOC: update the <your-function-or-method> docstring"
- [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`
- [X] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [X] The html version looks good: `python doc/make.py --single <your-function-or-method>`
- [X] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

```
################################################################################
################# Docstring (pandas.core.generic.NDFrame.tail) #################
################################################################################

Return the last n rows.

Parameters
----------
n : int, default 5
    Number of rows to select.

Returns
-------
type of caller
    The last `n` rows of the caller object.

See Also
--------
pandas.DataFrame.head : The first `n` rows of the caller object.

Examples
--------
>>> df = pd.DataFrame({'animal':['alligator', 'bee', 'falcon', 'lion',
...                    'monkey', 'parrot', 'shark', 'whale', 'zebra']})
>>> df
      animal
0  alligator
1        bee
2     falcon
3       lion
4     monkey
5     parrot
6      shark
7      whale
8      zebra

Viewing the last 5 lines

>>> df.tail()
   animal
4  monkey
5  parrot
6   shark
7   whale
8   zebra

Viewing the last n lines (three in this case)

>>> df.tail(3)
  animal
6  shark
7  whale
8  zebra

################################################################################
################################## Validation ##################################
################################################################################

Errors found:
	No extended summary found
```

Am not sure adding a summary would add much value.

Labels:
name: Docs

Comments:
Updated PR, thanks!
Thanks!
DOC: update the Series.isin docstring
State: closed

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

- [x] PR title is "DOC: update the <your-function-or-method> docstring"
- [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`
- [x] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [x] The html version looks good: `python doc/make.py --single <your-function-or-method>`
- [ ] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

```
################################################################################
######################## Docstring (pandas.Series.isin) ########################
################################################################################

Check whether ``values`` are contained in Series.

Return a boolean Series showing whether each element in the Series
is exactly contained in the passed sequence of ``values``.

Parameters
----------
values : set or list-like
    The sequence of values to test. Passing in a single string will
    raise a ``TypeError``. Instead, turn a single string into a
    ``list`` of one element.

    .. versionadded:: 0.18.1

    Support for values as a set.

Returns
-------
isin : Series (bool dtype)

Raises
------
TypeError
  * If ``values`` is a string

See Also
--------
pandas.DataFrame.isin : equivalent method on DataFrame

Examples
--------

>>> s = pd.Series(['lama', 'cow', 'lama', 'beetle', 'lama',
...               'hippo'], name='animal')
>>> s.isin(['cow', 'lama'])
0     True
1     True
2     True
3    False
4     True
5    False
Name: animal, dtype: bool

Passing a single string as ``s.isin('lama')`` will raise an error. Use
a list of one element instead:

>>> s.isin(['lama'])
0     True
1    False
2     True
3    False
4     True
5    False
Name: animal, dtype: bool

################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.Series.isin" correct. :)
```


Labels:
name: Docs

Comments:
Minor comment. LGTM otherwise.
DOC: update the docstring pandas.Series.dt.is_month_start
State: closed

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

- [X ] PR title is "DOC: update the <your-function-or-method> docstring"
- [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`
- [X] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [X] The html version looks good: `python doc/make.py --single <your-function-or-method>`
- [X] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

```
################################################################################
################# Docstring (pandas.Series.dt.is_month_start)  #################
################################################################################

Return a boolean indicating if the date is the first day of the month.

Returns
-------
is_month_start : Series of boolean

See Also
--------
is_month_end : Returns a boolean indicating if the date is the last day
               of the month.

Examples
--------
>>> dates = pd.Series(pd.date_range("2018-02-27", periods=3))
>>> dates
0   2018-02-27
1   2018-02-28
2   2018-03-01
dtype: datetime64[ns]
>>> dates.dt.is_month_start
0    False
1    False
2    True
dtype: bool

################################################################################
################################## Validation ##################################
################################################################################

Errors found:
	No extended summary found

```

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.

Extended summary not required in this case (confirmed by peers).

Labels:

Comments:
Hello @janelle! Thanks for submitting the PR.

 - In the file [`pandas/core/indexes/datetimes.py`](https://github.com/pandas-dev/pandas/blob/232520fc6625005ec6cc0d86e7d979ee1adbdb94/pandas/core/indexes/datetimes.py), following are the PEP8 issues :

> [Line 1739:80](https://github.com/pandas-dev/pandas/blob/232520fc6625005ec6cc0d86e7d979ee1adbdb94/pandas/core/indexes/datetimes.py#L1739): [E501](https://duckduckgo.com/?q=pep8%20E501) line too long (93 > 79 characters)
> [Line 1768:80](https://github.com/pandas-dev/pandas/blob/232520fc6625005ec6cc0d86e7d979ee1adbdb94/pandas/core/indexes/datetimes.py#L1768): [E501](https://duckduckgo.com/?q=pep8%20E501) line too long (96 > 79 characters)


Please, add "DOC: " prefix to the PR.
This LGTM once you fix the line to long issues. Ping me once that's fixed and we'll merge it.
closing as I might have mixed up two branches by accident, sorry
will open again for pandas.Series.dt.is_month_last to avoid confusion
DOC: update the pandas.date_range() docstring
State: closed

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

- [x] PR title is "DOC: update the <your-function-or-method> docstring"
- [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`
- [x] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [x] The html version looks good: `python doc/make.py --single <your-function-or-method>`
- [x] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

```
Errors found:
	Errors in parameters section
		Parameters {'kwargs'} not documented
```

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.


Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):

- [ ] closes #xxxx
- [ ] tests added / passed
- [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [ ] whatsnew entry


Labels:

Comments:
Can you insert the output of scripts/validate_docstrings.py? 
Just did.

`See Also` section is not being detected and I asked on the Gitter to @TomAugspurger , he said ignore kwargs
Looks like the validation fails?
Errors found:
	Errors in parameters section
		Parameters {'kwargs'} not documented
	See Also section not found
Just a couple small comments. Can ignore the kwargs issue.
@TomAugspurger : Please check changes now. I've made the changes as you suggested
Have made all the required changes as per reviewers feedback. Can be merged now!
@nipunbatra I pushed a commit with some whitespace normalization so that the doctests would pass.
@TomAugspurger I think you pinged the wrong Nipun :D 
Pinging https://github.com/nipunsadvilkar
😬 sorry!
@TomAugspurger : Thanks! Do I need to make any other changes?
Nope, we're good thanks!
DOC: update the parquet docstring
State: closed

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

- [x] PR title is "DOC: update the <your-function-or-method> docstring"
- [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`
- [x] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [x] The html version looks good: `python doc/make.py --single <your-function-or-method>`
- [x] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

```
################################################################################
################### Docstring (pandas.DataFrame.to_parquet)  ###################
################################################################################

Write a DataFrame to the binary parquet format.

.. versionadded:: 0.21.0

Requires either fastparquet or pyarrow libraries.

Parameters
----------
fname : str
    String file path.
engine : {'auto', 'pyarrow', 'fastparquet'}, default 'auto'
    Parquet library to use. If 'auto', then the option
    ``io.parquet.engine`` is used. The default ``io.parquet.engine``
    behavior is to try 'pyarrow', falling back to 'fastparquet' if
    'pyarrow' is unavailable.
compression : {'snappy', 'gzip', 'brotli', None}, default 'snappy'
    Name of the compression to use. Use ``None`` for no compression.
kwargs : dict
    Additional keyword arguments passed to the engine.

Examples
----------
>>> df = pd.DataFrame(data={'col1': [1, 2], 'col2': [3, 4]})
>>> df.to_parquet('df.parquet.gzip', compression='gzip')

Returns
----------
None

See Also
--------
DataFrame.to_csv : write a csv file.
DataFrame.to_sql : write to a sql table.
DataFrame.to_hdf : write to hdf.

################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.DataFrame.to_parquet" correct. :)
```

Labels:
name: Docs
name: IO Parquet
description: parquet, feather

Comments:
Hello @benman1! Thanks for updating the PR.



Cheers ! There are no PEP8 issues in this Pull Request. :beers: 

##### Comment last updated on March 12, 2018 at 11:03 Hours UTC
@benman1 I removed the Returns section, as I think it is not needed for the write functions (and we can ignore the error in the validation script)
Did the small edit before merging. 
@benman1 Thanks a lot!
DOC: update the MultiIndex docstring
State: closed

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

- [ ] PR title is "DOC: update the <your-function-or-method> docstring"
- [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`
- [ ] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [ ] The html version looks good: `python doc/make.py --single <your-function-or-method>`
- [ ] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

```
# paste output of "scripts/validate_docstrings.py <your-function-or-method>" here
# between the "```" (remove this comment, but keep the "```")

```

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.


Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):

- [ ] closes #xxxx
- [ ] tests added / passed
- [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [ ] whatsnew entry


Labels:
name: Docs

Comments:
Hello @jesrael! Thanks for submitting the PR.

 - In the file [`pandas/core/indexes/multi.py`](https://github.com/pandas-dev/pandas/blob/0b7cbc2f6f60e3ad6263f4860d9e8f8ea63242d6/pandas/core/indexes/multi.py), following are the PEP8 issues :

> [Line 1163:29](https://github.com/pandas-dev/pandas/blob/0b7cbc2f6f60e3ad6263f4860d9e8f8ea63242d6/pandas/core/indexes/multi.py#L1163): [E127](https://duckduckgo.com/?q=pep8%20E127) continuation line over-indented for visual indent


@jesrael do you need help working on this docstring?
@jesrael let us know if you want to continue working on this.
DOC: removed extra comma from date_range function docstring
State: closed

In the doc-string written in function date_range in file pandas/core/indexes/datetimes.py. I have found a little typo at https://github.com/pandas-dev/pandas/blob/master/pandas/core/indexes/datetimes.py#L2233. Please have a look at the pull request and suggest any edits if required.

Labels:
name: Docs
name: Datetime
description: Datetime data dtype

Comments:
Hmm I think that comma is OK https://en.wikipedia.org/wiki/Serial_comma :)
Alright, I think I should look for more better updations to documentation thanks for the quick response
:D.
#20128 is also working on this same function, let's coordinate.
DOC: update validate_docstrings.py Validation script checks for tabs
State: closed

Add a check to validate the docstrings don't have tabs.
The documentation uses whitespace only, adding the check will prevent
tabs being added in the sprint or future submissions

Sample output (elided non changed parts)
```
...

################################################################################
################################## Validation ##################################
################################################################################

Errors found:
	...
	Tabs found in the docstring, please use whitespace only
	...

```


Labels:
name: Docs

Comments:
Hello @mariocj89! Thanks for updating the PR.



Cheers ! There are no PEP8 issues in this Pull Request. :beers: 

##### Comment last updated on March 10, 2018 at 12:40 Hours UTC
@datapythonista @jorisvandenbossche if you could glance over this. It looks good to me.
@mariocj89 thanks!
Thank you!
DOC: Apply doc sprint
State: closed

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

- [x] PR title is "DOC: update the <your-function-or-method> docstring"
- [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`
- [x] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [ ] The html version looks good: `python doc/make.py --single <your-function-or-method>`
- [x] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

```
# paste output of "scripts/validate_docstrings.py <your-function-or-method>" here
# between the "```" (remove this comment, but keep the "```")

```

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.


Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):

- [ ] closes #xxxx
- [ ] tests added / passed
- [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [ ] whatsnew entry


Labels:
name: Docs
name: Reshaping
description: Concat, Merge/Join, Stack/Unstack, Explode

Comments:
@dtammaro Can you please udpate the title of the pull request, and copy the output of the script in the specified section? it's difficult to review otherwise
@datapythonista this doc-string prob needs another look, it is pretty long and complex so might be some more changes.
This has been merged in https://github.com/pandas-dev/pandas/pull/20202
DOC: update the pickle.py docstring
State: closed

Update

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

- [x] PR title is "DOC: update the <your-function-or-method> docstring"
- [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`
- [x] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [x] The html version looks good: `python doc/make.py --single <your-function-or-method>`
- [x] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

```
# paste output of "scripts/validate_docstrings.py <your-function-or-method>" here
# between the "```" (remove this comment, but keep the "```")

```

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.


Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):

- [x] closes #xxxx
- [x] tests added / passed
- [x] passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [x] whatsnew entry


Labels:
name: Docs
name: IO Data
description: IO issues that don't fit into a more specific label

Comments:
Hello @radovankavicky! Thanks for updating the PR.

 - In the file [`pandas/io/pickle.py`](https://github.com/pandas-dev/pandas/blob/6d0439454d8d11de17e36636e4f17bbeaabdf106/pandas/io/pickle.py), following are the PEP8 issues :

> [Line 32:1](https://github.com/pandas-dev/pandas/blob/6d0439454d8d11de17e36636e4f17bbeaabdf106/pandas/io/pickle.py#L32): [W293](https://duckduckgo.com/?q=pep8%20W293) blank line contains whitespace



##### Comment last updated on March 10, 2018 at 12:23 Hours UTC
This is being updated by https://github.com/pandas-dev/pandas/pull/20253 as well, so therefore closing this one. @radovankavicky I hope there was no error in the docstring assignment, in that case sorry!
DOC: update the MultiIndex.swaplevel docstring
State: closed

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

- [X] PR title is "DOC: update the <your-function-or-method> docstring"
- [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`
- [X] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [X] The html version looks good: `python doc/make.py --single <your-function-or-method>`
- [X] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

```
################################################################################
################### Docstring (pandas.MultiIndex.swaplevel)  ###################
################################################################################

Swap level i with level j.

Calling this method does not change the ordering of anything.

Parameters
----------
i : int, str
    First level of index to be swapped. Can pass level name as string.
    Type of parameters can be mixed.
j : int, str
    Second level of index to be swapped. Can pass level name as string.
    Type of parameters can be mixed.

Returns
-------
MultiIndex
    A newly allocated MultiIndex

.. versionchanged:: 0.18.1

   The indexes ``i`` and ``j`` are now optional, and default to
   the two innermost levels of the index.

See Also
--------
MultiIndex : A multi-level, or hierarchical, index object for
    pandas objects.

Examples
--------
>>> mi = pd.MultiIndex(levels=[['a', 'b'], ['bb', 'aa']],
...                    labels=[[0, 0, 1, 1], [0, 1, 0, 1]])
>>> mi
MultiIndex(levels=[['a', 'b'], ['bb', 'aa']],
   labels=[[0, 0, 1, 1], [0, 1, 0, 1]])
>>> mi.swaplevel()
MultiIndex(levels=[['bb', 'aa'], ['a', 'b']],
   labels=[[0, 1, 0, 1], [0, 0, 1, 1]])

################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.MultiIndex.swaplevel" correct. :
```

Labels:
name: Docs
name: MultiIndex

Comments:
Updated PR after review, thanks!
Thanks @xrmx !
Create new file with .csv extension
State: closed

If the .csv extension is not especified, the to_csv inserts.


```
df = pandas.read_csv("file.csv")

df.to_csv("new_file")
```

File created = new_file.csv

Labels:
name: IO CSV
description: read_csv, to_csv

Comments:
this is too opionated by pandas. if you really want to suggest this, pleas open an issue first.