I¹m still against docs with static code samples written in them.  Its very
hard to make sure they compile if they are not part of a testable project.
Its really frustrating to cut and paste and example from a online doc and
find that it doesn¹t work.  Do we really have the ability to test that in
our current help? I¹d way rather see us give a newt command to download
samples from an examples package library so we can build them in CI and
ensure they at least compile.


We have a regression test framework. Perhaps we can make samples in the documentation into regression tests, and mark them with a tag (e.g. @docsample)

That way, if we have a regression test failure, we can also mark it as a documentation failure.

Sterling

Reply via email to