Uploaded image for project: 'CDAP'
  1. CDAP
  2. CDAP-8009

All documentation code snippets should come from tested examples

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 4.0.0
    • Fix Version/s: None
    • Labels:
      None
    • Rank:
      1|hzzrpj:

      Description

      In the documentation, we have numerous example fragments. These can become out-of-date over time. To stop this from happening, have all fragments come from working examples.

      The examples need not be shipped as part of the SDK, nor need they be fully-documented as an example. They just need to be built and tested, so that way removed methods and classes don't get referenced in the documentation after they have gone.

        Attachments

          Activity

            People

            • Assignee:
              nitin Nitin Motgi
              Reporter:
              John John Jackson
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: