This is a big problem for me too. I keep on having problems with my Cmdliner examples being out of sync and it’s a real PITA to maintain.
There’s a simple and obvious solution to this problem which has been lingering for long here. But unfortunately people do not like simple and obvious solutions. You can read about the complex plans in this discussion which have, unsurprisingly, never materialized.