DOC: add PeriodIndex.asfreq docstring

[TomAugspurger]

Part of #6384

I guess PeriodIndex don't show up in the API docs at all. Not sure if I'll get to any more.

[jorisvandenbossche]

Can you use --- instead of === for the lines? (to be consistent with the other docstrings)

[TomAugspurger]

@jorisvandenbossche thanks. Should be good now I think

[jorisvandenbossche]

a small one :-)
here also a space between new and :

[jorisvandenbossche]

@TomAugspurger added some more .. :-)

[jreback]

@TomAugspurger can you update?

[TomAugspurger]

@jreback done. Merge when you're ready.

[jorisvandenbossche]

@TomAugspurger I think you forgot to add your changes

[TomAugspurger]

Seems to be good now.

[jreback]

I realize after we merge index-repr prob need to fix s bunch of doc strings :(

[jreback]

e.g. will be.

In [1]: pidx = pd.period_range('2010-01-01', '2015-01-01', freq='A')

In [2]: pidx
Out[2]: PeriodIndex(['2010', '2011', '2012', '2013', '2014', '2015'], dtype='int64', freq='A-DEC')

In [3]: pidx.asfreq('M')
Out[3]: PeriodIndex(['2010-12', '2011-12', '2012-12', '2013-12', '2014-12', '2015-12'], dtype='int64', freq='M')

In [4]: pidx.asfreq('M', how='S')
Out[4]: PeriodIndex(['2010-01', '2011-01', '2012-01', '2013-01', '2014-01', '2015-01'], dtype='int64', freq='M')

[jorisvandenbossche]

Indeed. A search for <class 'pandas.tseries.period.PeriodIndex'> and alike can help there maybe. I will open an issue for that. -> #10094