Mobius icon indicating copy to clipboard operation
Mobius copied to clipboard

Incorrect MarkDown syntax in API Documentation

Open andrewjw1995 opened this issue 7 years ago • 0 comments

The documentation file appears to have been generated with no space between the hashes and the header text. This is causing the headers to not display correctly, and is difficult to read. See below for an example of with and without the space:

##

<H1>Mobius API Documentation</H1>
###Microsoft.Spark.CSharp.Core.Accumulator ####Summary
        A shared variable that can be accumulated, i.e., has a commutative and associative "add"
        operation. Worker tasks on a Spark cluster can add values to an Accumulator with ...


<H1>Mobius API Documentation</H1>

Microsoft.Spark.CSharp.Core.Accumulator

Summary

        A shared variable that can be accumulated, i.e., has a commutative and associative "add"
        operation. Worker tasks on a Spark cluster can add values to an Accumulator with ...

andrewjw1995 avatar May 16 '18 05:05 andrewjw1995