Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-11337 Make example code in user guide testable
  3. SPARK-11399

Include_example should support labels to cut out different parts in one example code

    XMLWordPrintableJSON

Details

    • Sub-task
    • Status: Closed
    • Major
    • Resolution: Won't Fix
    • None
    • None
    • Documentation
    • None

    Description

      There are many small examples that do not need to create a single example file. Take the MLlib datatype page – mllib-data-types.md – as an example, code examples like creating vectors and matrices are trivial works. We can merge them into one single vector/matrix creation example. Then we use labels to distinguish each other, such as

      {% include_example xxxx.scala vector_creation %}

      .

      The "label way" is also useful in the dialog-style code example: http://spark.apache.org/docs/latest/mllib-linear-methods.html#streaming-linear-regression.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              yinxusen Xusen Yin
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: