Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-18615

Switch to multi-line doc to avoid a genjavadoc bug for backticks

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.1.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      I suspect this is related with SPARK-16153 and genjavadoc issue in https://github.com/typesafehub/genjavadoc/issues/85 but I am not too sure.

      Currently, single line comment does not mark down backticks to <code>..</code> but prints as they are. For example, the line below:

      /** Return an RDD with the pairs from `this` whose keys are not in `other`. */
      

      So, we could work around this as below:

      /**
       * Return an RDD with the pairs from `this` whose keys are not in `other`.
       */
      

      Please refer the image in the pull request.

        Attachments

          Activity

            People

            • Assignee:
              hyukjin.kwon Hyukjin Kwon
              Reporter:
              hyukjin.kwon Hyukjin Kwon
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: