#4581 Testable help text
Opened 9 years ago by pspacek. Modified 7 years ago

Disclamer: This is a wild idea.

Built-in help in IPA is hard to maintain and almost never tested. Maybe we could invent something like "testable help".

Command examples in help text could be (somehow) internally tagged to allow test framework to extract commands, run them, and check if they succeeded. This would probably require either some sort of command ordering or additional metadata (pre-test and post-test code snippets).

I expect that it would be harder to write the command examples initially but then it should be write-and-forget without fear that command examples will get obsolete/disfunctional.


Interesting idea though this will not be easy to set up. As we try not to do backward incompatible changes, there are not that many breakages (except the last --ip-address...). It is all question of balancing benefits&required work.

Moving to later milestone - we will see if this becomes a serious issue and we would need to implementing something like that.

Metadata Update from @pspacek:
- Issue assigned to someone
- Issue set to the milestone: Future Releases

7 years ago

Login to comment on this ticket.

Metadata