DOC: update the Period.qyear 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"

 

- [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:

```
(pandas_dev) ani@ani-Lenovo-G50-80:~/github/pandas/scripts$ python validate_docstrings.py  

- [ ] pandas.Period.qyear

################################################################################
####################### Docstring (pandas.Period.qyear)  #######################
################################################################################

Return a year of the given date.

This function simply find the year of the given date that period fallsin.

Returns
-------
int

See Also
--------
Period.qyear :Return the year of the date

Examples
--------
>>> p = pd.Period("2014-9-21", freq="A")
>>> p.qyear
2014

################################################################################
################################## Validation ##################################
################################################################################

```

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.

Labels:
name: Docs

Comments:
# [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/20333?src=pr&el=h1) Report
> Merging [#20333](https://codecov.io/gh/pandas-dev/pandas/pull/20333?src=pr&el=desc) into [master](https://codecov.io/gh/pandas-dev/pandas/commit/6008d75ac00aa7c3052b74bf4f6eb73beeaf56a6?src=pr&el=desc) will **decrease** coverage by `0.05%`.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/pandas-dev/pandas/pull/20333/graphs/tree.svg?height=150&width=650&token=eZ4WkYLtcO&src=pr)](https://codecov.io/gh/pandas-dev/pandas/pull/20333?src=pr&el=tree)

```diff
@@            Coverage Diff             @@
##           master   #20333      +/-   ##
==========================================
- Coverage    91.9%   91.84%   -0.06%     
==========================================
  Files         160      153       -7     
  Lines       49904    49256     -648     
==========================================
- Hits        45864    45241     -623     
+ Misses       4040     4015      -25
```

| Flag | Coverage Δ | |
|---|---|---|
| #multiple | `90.23% <ø> (-0.06%)` | :arrow_down: |
| #single | `41.9% <ø> (-0.2%)` | :arrow_down: |

| [Impacted Files](https://codecov.io/gh/pandas-dev/pandas/pull/20333?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [pandas/core/arrays/base.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL2Jhc2UucHk=) | `84.14% <0%> (-3.72%)` | :arrow_down: |
| [pandas/io/formats/printing.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL2lvL2Zvcm1hdHMvcHJpbnRpbmcucHk=) | `89.38% <0%> (-3.71%)` | :arrow_down: |
| [pandas/core/indexes/period.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvaW5kZXhlcy9wZXJpb2QucHk=) | `92.61% <0%> (-1.8%)` | :arrow_down: |
| [pandas/core/dtypes/missing.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvZHR5cGVzL21pc3NpbmcucHk=) | `91.07% <0%> (-1.46%)` | :arrow_down: |
| [pandas/core/reshape/tile.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvcmVzaGFwZS90aWxlLnB5) | `93.37% <0%> (-1.37%)` | :arrow_down: |
| [pandas/plotting/\_core.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL3Bsb3R0aW5nL19jb3JlLnB5) | `82.5% <0%> (-1.07%)` | :arrow_down: |
| [pandas/util/\_test\_decorators.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL3V0aWwvX3Rlc3RfZGVjb3JhdG9ycy5weQ==) | `91.89% <0%> (-0.8%)` | :arrow_down: |
| [pandas/core/tools/datetimes.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvdG9vbHMvZGF0ZXRpbWVzLnB5) | `84.43% <0%> (-0.79%)` | :arrow_down: |
| [pandas/core/indexing.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvaW5kZXhpbmcucHk=) | `93.02% <0%> (-0.71%)` | :arrow_down: |
| [pandas/io/common.py](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree#diff-cGFuZGFzL2lvL2NvbW1vbi5weQ==) | `70.04% <0%> (-0.62%)` | :arrow_down: |
| ... and [69 more](https://codecov.io/gh/pandas-dev/pandas/pull/20333/diff?src=pr&el=tree-more) | |

------

[Continue to review full report at Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/20333?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/20333?src=pr&el=footer). Last update [6008d75...ca3beb5](https://codecov.io/gh/pandas-dev/pandas/pull/20333?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).

Can you figure out how `qyear` differs from `year`?
@TomAugspurger  I am not getting difference between qyear and year. If any advice for me then please give me.
Not sure. Perhaps @jbrockmendel knows.
I think the distinction is for `freq`s where the calendar-quarter doesn't line up with the fiscal quarter.

```
per = pd.Period('2016Q1', freq='Q')
per2 = pd.Period('2016Q1', freq='Q-JUN')

>>> per.start_time
Timestamp('2016-01-01 00:00:00')

>>> per2.start_time
Timestamp('2015-07-01 00:00:00')

>>> per2.year
2015
>>> per2.qyear
2016
```
Thanks @jbrockmendel for your advice.
Please check the PR @jbrockmendel and give review. 
+1 to each of Tom's points.
@TomAugspurger review it.
@jbrockmendel can you please review?
Thanks for the contribution @uttamaniket, and sorry for the delay in taking care of it.