gh-126273: added clinic docstrings to elementtree

[pan324]

• Issue: Missing docstrings on some objects in the xml.etree C implementation. #126273

[skirpichev]

clinic/* files are autogenerated by Tools/clinic/clinic.py. You should modify instead clinic input - Modules/_elementtree.c in your case, I guess.

See also: https://devguide.python.org/development-tools/clinic/

[pan324]

Thanks, will do that now.

[erlend-aasland]

Consider using per-parameter docstrings here (see the Argument Clinic Howto for inspiration).

Consider this also for the rest of the PR.

[erlend-aasland]

Please consistently use the imperative mood for reference prose. Ditto for the rest of the PR.

Suggested change

	Returnslistcontainingallmatchingelementsindocumentorder.
	Returnalistcontainingallmatchingelementsindocumentorder.

[erlend-aasland]

Normally we try to align the docstrings with the reference text in the documentation. In some places, this is already done (the added docstring is similar or identical to the reference docs), but in some places it differs significantly. If the reason for the deviation is that the docs are inaccurate, we should IMO fix them (first), and then align the added docstrings to the amended docs. Moreover, my previous round of review remarks have not been addressed yet.

[bedevere-app]

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

[python-cla-bot]

The following commit authors need to sign the Contributor License Agreement:

• 103143968+pan324@users.noreply.github.com

[github-actions]

This PR is stale because it has been open for 30 days with no activity.

[StanFromIreland]

Closing as the CLA is unsigned, there are conflicts and requested changes have not been made. Please create a new PR if you wish to pick this up again.