RFR: 7903866: apidiff: add an example to the doc [v2]

[Andrew Haley]

On Thu, 17 Oct 2024 18:55:28 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> It is intended that `--compare-api-descriptions` should default to `true`, although it is not wrong to be explicit. If you found it to be necessary, that would be worth investigating.

I find it very hard to understand the ifs and buts in the description of this option, and @alanbateman used the option this way. Please advise me to leave it in or take it out.

-------------

PR Review Comment: https://git.openjdk.org/apidiff/pull/26#discussion_r1807789458