ENH: make guess_datetime_format public

[nnlnr]

• closes ENH: make guess_datetime_format public #54727 (Replace xxxx with the GitHub issue number)
• Tests added and passed if fixing a bug or adding a new feature
• All code checks passed.
• [NA] Added type annotations to new arguments/methods/functions.
• Added an entry in the latest doc/source/whatsnew/v2.1.1.rst file if fixing a bug or adding a new feature.

[mroeschke]

Suggested change

	- Enhancement in :meth:`_libs.tslibs.parsing.guess_datetime_format` to make public (:issue:`54727`)
	- :meth:`pandas.tseries.guess_datetime_format` is now available (:issue:`54727`)

Can you move this to the other enhancement section?

[mroeschke]

Also this should be in 2.2.0.rst

[nnlnr]

WIll do - thanks for the review!

[nnlnr]

moved enhancement note to 2.2.0.rst unde the Other Enhancements section ✅

[mroeschke]

Could you add this to the API reference documentation?

[nnlnr]

Could you add this to the API reference documentation?

is the API reference documentation in doc/source/reference/api? If so, I'm seeing that path in the .gitignore file - is there a procedure to update the API reference under this context?

[mroeschke]

I think you can just add an entry to doc/source/reference/general_functions.rst

[MarcoGorelli]

thanks for your pr

whilst we're changing this

• in the guess_Datetime_format docstring, where it says

    Warning: dayfirst=True is not strict, but will prefer to parse

    with day first (this is a known bug).

could you write that as a sphinx directive? so .. warning::. check the to_datetime docs, there's something similar there

• could we add an example to the docstring please? just a simple one-liner of it guessing a datetime format, and another one-liner of it not being able to guess another one, will do

[nnlnr]

Thanks for the review and comments @mroeschke and @MarcoGorelli

• added an entry to doc/source/reference/general_functions.rst ✅
• updated warning in docstring as sphinx directive ✅
• added examples to docstring ✅

[MarcoGorelli]

Can you fix the failing ci checks please

[nnlnr]

👋 I'm getting a bit stuck with these failing checks - which seem to be mostly due to the following attribute error:
AttributeError: module 'pandas' has no attribute 'guess_datetime_format'

I updated the docstring in parsing.pyx with a sphinx ..warning:: directive and added two examples (learned that formatting was important which was a good lesson); however not sure how to address the failing jobs - any feedback or advice on how to troubleshoot?

[github-actions]

This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this.

[MarcoGorelli]

hi @nnlnr - is this still active? if you could fixup the conflicts I can finish it up

[nnlnr]

👋 @MarcoGorelli - thanks! That would be great - let me fix up the conflicts and circle back here

[MarcoGorelli]

website build looks good:

merging then, thanks @nnlnr !

[MarcoGorelli]

going to need @mroeschke to approve before this can be merged

[MarcoGorelli]

extra line, but it doesn't seem to make any difference in the build so is OK imo

[mroeschke]

Could you also add a whatsnew note in 2.2 under the Other Enhancements section?

[mroeschke]

Thanks @nnlnr and @MarcoGorelli

[nnlnr]

Thanks @MarcoGorelli @mroeschke!! 🎉 🙏