Uploaded image for project: 'Qt Creator'
  1. Qt Creator
  2. QTCREATORBUG-24238

API / Documentation prototype mistmatches

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Reported
    • Priority: P4: Low
    • Resolution: Unresolved
    • Affects Version/s: Qt Creator 4.10.0
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      While using QtCreator, it gave me a handy tooltip:

       

      QVector<int> v;
      v.remove( -> tooltip [2 of 2| void remove(int i, int *n*)]

      However the documentation says: "void remove(int i, int count)". (Due to the brevity of i and n, I wanted to make sure I was putting the right values in the right places)
      I had expected the tooltip to be [2 of 2| void remove(int i, int *count*)]

      I posted this to the QtC mailing list and was advised to post about it here. Not sure if there is an automated way to check that the API names match the documentation names. FWIW, I prefer count because that is more specific than n.

      It's a small detail, but rather important, I think. 

        Attachments

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

          Activity

            People

            Assignee:
            jkobus Jarek Kobus
            Reporter:
            jasonapk Jason Hihn
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:

                Gerrit Reviews

                There are no open Gerrit changes