DOC : update the pandas.Period.weekday docstring
State: closed

# Period.weekday

################################################################################
###################### Docstring (pandas.Period.weekday)  ######################
################################################################################

Get day of the week that a Period falls on.

Returns
-------
int

See Also
--------
Period.dayofweek : Get the day component of the Period.
Period.week : Get the week of the year on the given Period.

Examples
--------
>>> p = pd.Period("2018-03-11", "H")
>>> p.weekday
6

>>> p = pd.Period("2018-02-01", "D")
>>> p.weekday
3

>>> p = pd.Period("2018-01-06", "D")
>>> p.weekday
5

################################################################################
################################## Validation ##################################
################################################################################

Labels:
name: Docs
name: Period
description: Period data type

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

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

```diff
@@            Coverage Diff             @@
##           master   #20413      +/-   ##
==========================================
- Coverage   91.96%    91.8%   -0.17%     
==========================================
  Files         166      152      -14     
  Lines       50331    49205    -1126     
==========================================
- Hits        46289    45171    -1118     
+ Misses       4042     4034       -8
```

| Flag | Coverage Δ | |
|---|---|---|
| #multiple | `90.18% <ø> (-0.18%)` | :arrow_down: |
| #single | `41.85% <ø> (-0.38%)` | :arrow_down: |

| [Impacted Files](https://codecov.io/gh/pandas-dev/pandas/pull/20413?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [pandas/io/s3.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL2lvL3MzLnB5) | `72.72% <0%> (-13.64%)` | :arrow_down: |
| [pandas/util/\_doctools.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL3V0aWwvX2RvY3Rvb2xzLnB5) | `0% <0%> (-12.88%)` | :arrow_down: |
| [pandas/core/arrays/base.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL2Jhc2UucHk=) | `80.64% <0%> (-7.22%)` | :arrow_down: |
| [pandas/io/formats/terminal.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL2lvL2Zvcm1hdHMvdGVybWluYWwucHk=) | `16.43% <0%> (-4.55%)` | :arrow_down: |
| [pandas/io/formats/printing.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL2lvL2Zvcm1hdHMvcHJpbnRpbmcucHk=) | `89.38% <0%> (-3.71%)` | :arrow_down: |
| [pandas/core/dtypes/missing.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvZHR5cGVzL21pc3NpbmcucHk=) | `91.07% <0%> (-2.5%)` | :arrow_down: |
| [pandas/io/common.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL2lvL2NvbW1vbi5weQ==) | `68.77% <0%> (-1.88%)` | :arrow_down: |
| [pandas/util/testing.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL3V0aWwvdGVzdGluZy5weQ==) | `83.95% <0%> (-1.74%)` | :arrow_down: |
| [pandas/core/reshape/tile.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvcmVzaGFwZS90aWxlLnB5) | `93.37% <0%> (-1.37%)` | :arrow_down: |
| [pandas/core/indexes/interval.py](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvaW5kZXhlcy9pbnRlcnZhbC5weQ==) | `93.08% <0%> (-1.23%)` | :arrow_down: |
| ... and [91 more](https://codecov.io/gh/pandas-dev/pandas/pull/20413/diff?src=pr&el=tree-more) | |

------

[Continue to review full report at Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/20413?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/20413?src=pr&el=footer). Last update [ce87d06...fcaaf4b](https://codecov.io/gh/pandas-dev/pandas/pull/20413?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).

@jbrockmendel do you mind reviewing this docstring? (both are the same, we can't reuse in this case)
Pending typo fixups, LGTM.
Thanks @IHackPy for the PR, and thanks @jbrockmendel for the reviews.
Thanks Marc ! and sorry I forget to complete some string I thought . I will
update soon.

On Wed, Jul 18, 2018 at 3:23 PM, Marc Garcia <notifications@github.com>
wrote:

> Thanks @IHackPy <https://github.com/IHackPy> for the PR, and thanks
> @jbrockmendel <https://github.com/jbrockmendel> for the reviews.
>
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub
> <https://github.com/pandas-dev/pandas/pull/20413#issuecomment-405876872>,
> or mute the thread
> <https://github.com/notifications/unsubscribe-auth/AV3rxUjxkNSmABFkgy8Ls3fZiDOhnRYiks5uHwWagaJpZM4SwtDn>
> .
>



-- 

Thanks and Regards
Himanshu Awasthi,
Freelancer & Enthusiastic Engineering Student
KanpurFOSS Community
+91 7310476826 |Twitter @IHackPY <https://twitter.com/IHackPY>