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

Make style changes according to the MS Style Guide

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • Qt Creator 13.0.0-beta1
    • Documentation
    • None

    Description

      Some conventions used in the Qt Creator Manual and Qt Design Studio Manual predate the decision to start following and enforcing the Microsoft Style Guide. This topic lists the found deviations:

      Current MS Style Guide Link Fixed
      (you) can Rewrite to leave out, unless it is about the ability to do something (not the possibility) https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may  
      directory/folder folder (except "in content for developers when you need to refer to the structure of the file system or to match the API") https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/d/directory  
      drag-and-drop drag https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/d/drag-and-drop QDS-14114
      deselect check box clear checkbox https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/check-checkbox-check-mark QDS-14114
      field (for everything, except checkboxes and sometimes lists) Leave out or use "box" or "checkbox" if really needed https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/f/field  
      select (for everything except plugins) go to (for menu items, tabs, views and other locations, and websites) https://learn.microsoft.com/en-us/style-guide/procedures-instructions/describing-interactions-with-ui QDS-14114
      development PC, machine, host computer (with lots of exceptions) https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/computer-device-terms  
      enable/disable Turn on/off https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/e/enable-enables
       
      https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/d/disable-disabled      		  
      Internet internet
       
      Also, check that we use "internet" and "web" correctly.      		 https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/i/internet-intranet-extranet
       
      https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/w/web-world-wide-web-www      		  
      specify select (or any other verb that is accurate for the case) https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/s/set-specify  
             
             

      Attachments

        Issue Links

          is covered by

          Task - A task that needs to be done. QDS-14114 Update verbs for interacting with UI

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              leenam Leena Miettinen
              leenam Leena Miettinen
              Kimmo Leppälä Kimmo Leppälä
              Mats Honkamaa Mats Honkamaa
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes