Description
Working on PR #129607 noticed that one parameter was missing in http.server.HTTPServer
documentation, so I decided to send a separate PR to update the documentation and at the same time check some more entities in the stdlib.
And I started to finding a lot of such cases and wanted to automate it. Then I found out that sphinx
already has something similar to do automatically now I offer you this as an idea. Maybe it is possible to include such a feature in sphinx
or write your own script so that it checks this in CI (for example using inspect
and rst parser).
It seems very important to me that the documentation is accurate in such things and doesn't become outdated
I don't think it's a good practice for contributors to change parameters in the documentation themselves (or forget about it :-).
At least we could report discrepancies between documentation and annotations from code.
I'll send PR with what I've already found.
Linked PRs
Metadata
Metadata
Assignees
Projects
Status