Uploaded image for project: 'Qt for Python'
  1. Qt for Python
  2. PYSIDE-1206

Investigate how to document the global functions available with a module

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: P2: Important
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None
    • Technical Risk:
      Normal
    • Sprint:
      DaVinci sprint 2

      Description

      Qt Core offers convenience headers such as, <QtMath>, <QtAlgorithm>, and so on, which offer a few functions. Some of the functionality offered by these headers are available with the module import in Python. For example, qAcos(), qAtan(), qAsin(), and many more.

      In Qt, such functionality is documented using qdoc's \headerfile command. But in Python, we don't need to include any additional  imports to access the functions. We should investigate how we can include the existing documentation for these functions in the Qt for Python documentation.

        Attachments

          Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            Activity

              People

              Assignee:
              veshivas Venugopal Shivashankar
              Reporter:
              veshivas Venugopal Shivashankar
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes