Missing show_versions() in documentation

[MarianD]

pandas.show_versions()

is not in pandas API Reference.

[TomAugspurger]

It's primarily used for bug reports. Is there a reason you'd like to see it in the API documentation?

We'd also need someone to write a docstring for it.

[MarianD]

@TomAugspurger

Is there a reason you'd like to see it in the API documentation?

For completeness. Once I need it (I knew that there is such a function) but I didn't remember its name. So I tried finding it in lists of API reference General functions and General utility functions.

We'd also need someone to write a docstring for it.

I may do it. I need some days to find its source code and get acquainted with common rules for docstrings in pandas, and learn the order of steps how to accomplish it in git — or do you suppose other way for doing it?

[TomAugspurger]

The source is at https://github.com/pandas-dev/pandas/blob/e7ee418fa7a519225203fef23481c5fa35834dc3/pandas/util/_print_versions.py#L90. Our contributing guide has a section on writing docstrings.

…

On Thu, Mar 26, 2020 at 4:30 PM Marian Denes ***@***.***> wrote: @TomAugspurger <https://github.com/TomAugspurger> Is there a reason you'd like to see it in the API documentation? For completeness. Once I need it (I knew that there is such a function) but I didn't remember its name. So I tried finding it in lists of API reference General functions and General utility functions. We'd also need someone to write a docstring for it. I may do it. I need some days to find its source code and get acquainted with common rules for docstrings in pandas, and learn the order of steps how to accomplish it in git — or do you suppose other way for doing it? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#33044 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKAOISXLTVLNKTG5442GQLRJPCPZANCNFSM4LUNI5QQ> .

[MarianD]

@TomAugspurger, thanks for useful info.

[MarianD]

@TomAugspurger, I just wrote the docstring — see my pull request #33073.