DOC: Unclear documentation for Period Construction

[cancan101]

The documentation is unclear as to what the date passed to a Period means: whether it is the start date or the end date of the period. Convention is that fiscal quarters are usually stated by the date the quarter ends, whereas weeks are many times stated by the day week starts. This is especially unclear given that the default freq='W' is W-SUN which means the "week ending on Sunday" whereas one convention is to show weeks starting on Sunday.

I would recommend clearing this up in the documentation.

[ShaharNaveh]

@sunaymehta Sure we would love to accept a PR!

---

The location of the Period documentation is at

pandas/pandas/_libs/tslibs/period.pyx

Line 2375 in eab7226

class Period(_Period):

ATM what is missing is some examples on how to construct a period.

[nexus-hash]

Hey since the Issue is still open. I am currently looking into it.

[nexus-hash]

From your reference, I guess you want to keep some examples of how to construct a Period, here-

[NishitaPatnaik21]

Is this still open? Can I take this?

[sonia1goyal]

Hi @jreback, Is this issue still open? I would like to work on it.

[MarcoGorelli]

Pull requests are welcome

[athielem]

Hey, would be interested to work on this as a good first issue!

[jackgoldsmith4]

take