Uploaded image for project: 'SystemDS'
  1. SystemDS
  2. SYSTEMDS-156

Need better documentation for PYDML function parameters

    XMLWordPrintableJSON

Details

    • Task
    • Status: Resolved
    • Minor
    • Resolution: Won't Fix
    • None
    • Not Applicable
    • Documentation
    • None

    Description

      The various PyDML functions need improved documentation describing their functionality and the parameters that they take.

      For example, the full() function in the PyDML Language Reference shows:
      x = full(4, 4, 3)
      But there's no description of what each parameter is. Additionally, the "Python syntax for DML" shows an example, but the parameters are in the wrong order. This can make it frustrating to write PyDML.

      So right now issues like this can require someone to have to read source code to figure out the correct parameter syntax.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              deron Jon Deron Eriksson
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: