When a developer modifies IPA API but forgets to run python makeapi.in, the generated API doc (in doc/api/) can become out of date. The tool makeapi.in currently does multiple tasks: - generate the file API.txt - generate the doc in doc/api and it supports the option --validate but this option does not check the accuracy of the doc/api files.
python makeapi.in
--validate
It would be nice if python makeapi.in --validate could also check the accuracy of the doc/api files, as this command is executed in our azure pipelines. This way, when a developer opens a PR but forgets to update the API files, the CI would catch the issue.
python makeapi.in --validate
Metadata Update from @antorres: - Issue assigned to antorres
master:
ipa-4-9:
ipa-4-10:
Metadata Update from @frenaud: - Issue close_status updated to: fixed - Issue status updated to: Closed (was: Open)
Login to comment on this ticket.