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

ambiguous sentence in documentation

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Done
    • Not Evaluated
    • 5.0.0
    • 4.8.2
    • Documentation
    • None
    • Id9158ba1f7ffa5af169f808aed4559f7a0470e20

    Description

      Quote from QVariant Class Reference:
      "bool QVariant::toBool () const
      [...]
      Returns true if the variant has type() Bool, Char, Double, Int, LongLong, UInt, or ULongLong and the value is non-zero, or if the variant has type String or ByteArray and its lower-case content is not empty, "0" or "false"; otherwise returns false."

      This is ambiguous, because it's not clear if you mean: (Heed the brackets in the sentences)
      1) Returns true if the variant has type() Bool, Char, Double, Int, LongLong, UInt, or ULongLong and the value is non-zero, or if the variant has type String or ByteArray and its lower-case content is (not empty), "0" or "false"; otherwise returns false."

      or

      2) Returns true if the variant has type() Bool, Char, Double, Int, LongLong, UInt, or ULongLong and the value is non-zero, or if the variant has type String or ByteArray and its lower-case content is not (empty, "0" or "false"); otherwise returns false."

      I know myself that brackets are only coder style and not a good "normal" text style, but i don't know a better solution if the sentences should stay short.

      Attachments

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

        Activity

          People

            mitch_curtis Mitch Curtis
            v_dirr Volker Dirr
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes