DOC: Add docstrings for fixtures defined from pandas.tests.io.conftest

[jordan-d-murphy]

Add docstrings for fixtures defined from pandas.tests.io.conftest

• xref Document our pytest fixtures #19159
• Tests added and passed if fixing a bug or adding a new feature
• All code checks passed.
• Added type annotations to new arguments/methods/functions.
• Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

[jordan-d-murphy]

@datapythonista would you please give this PR a review and share any feedback?

[datapythonista]

Is there any validation for it we are trying to enforce? I personally don't see much value here otherwise. It'd be nice to have proper documentation for fixtures for sure, but that would take understanding well them and providing useful information on what they are exactly and when they can be used. This PR seems to simply repeat the fixture names in a more verbose way. I'd prefer to not have them rather than this.

[mroeschke]

Agreed with @datapythonista on the value of this. If you're interested, continuing to enforce numpydoc validations would be worthwhile: https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks

[jordan-d-murphy]

@datapythonista @mroeschke

Thank you gentlemen, I appreciate the feedback and guidance!

One way I do think this adds value is when running pytest --fixtures pandas the output before these changes is:

and after adding the docstrings:

Considering this, is this meaningful to add? If not, I'm happy to revert these changes and move on to working on continuing to enforce numpydoc validations as Matthew suggested.

[mroeschke]

Considering this, is this meaningful to add?

Just to make my last comment clearer - I would still be OK with documenting these pytest fixtures, but I don't think there's a ton of value (impact) in doing so.

[jordan-d-murphy]

@mroeschke I've opened #57111 to continue work on enforcing numpydoc validations: https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks