Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-73335

QDialog - documentation wording around "we"

    XMLWordPrintable

Details

    • All
    • 48405219fbd43f4b309ca7c820e70e59e6375e5d (qt/qtbase/dev)

    Description

      Sorry in advance for this, probably slightly fastidious, report. But the documentation of QDialog might have potential to become even better.

      Honestly, the following sentence delayed me for a while and I'm still uncertain:

      "Typically, to get the dialog to close and return the appropriate value, we connect a default button, e.g. OK, to the accept() slot and a Cancel button to the reject() slot."

      Does this mean that these connections are established by the QDialog itself - i.e. implemented by You (the authors of the framework) - or does this mean that I, as the user of the framework, need to establish these connections myself? If so, I suggest to change the wording to:

      "Typically, to get the dialog to close and return the appropriate value, you have to connect a default button, e.g. OK, to the accept() slot and a Cancel button to the reject() slot."

      If these connections are to be established automatically by QDialog, there might be a bug, since they are not.

      I would generally recommend to avoid atypical uses of 'we' in documentations. https://en.wikipedia.org/wiki/We#Atypical_uses_of_we

      Attachments

        For Gerrit Dashboard: QTBUG-73335
        # Subject Branch Project Status CR V

        Activity

          People

            docteam Qt Documentation Team
            ralfkubis Ralf Kubis
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes