Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-69889

ID is an identification document not an identifier

XMLWordPrintable

      The documentation for the input step used ID when taking about the id field.

      The field is not an Identification document but an identifier so should be refered to as either id or identifier  but never ID which is an abbreviation of Identification document

          [JENKINS-69889] ID is an identification document not an identifier

          James Nord created issue -
          James Nord made changes -
          Labels New: hacktoberfest newbie-friendly

          Daniel Beck added a comment -

          FWIW https://acronyms.thefreedictionary.com/ID disagrees (so at least it's not universal). Is this a British English thing perhaps?

          Daniel Beck added a comment - FWIW https://acronyms.thefreedictionary.com/ID disagrees (so at least it's not universal). Is this a British English thing perhaps?

          James Nord added a comment - - edited

          this quote from a random stack exchange is probably the best advice:

          In documentation it should be spelled out (ID abbreviates two different words, after all).

          James Nord added a comment - - edited this quote from a random stack exchange is probably the best advice: In documentation it should be spelled out (ID abbreviates two different words, after all).

          BHARATH added a comment -

          Can I work on this issue?
          AFAIK, it was incorrect to mention "ID" where it was supposed to be an id or identifier. 

          BHARATH added a comment - Can I work on this issue? AFAIK, it was incorrect to mention "ID" where it was supposed to be an id or identifier. 

          Mark Waite added a comment -

          bharath_4232 you are welcome to work on it. The change needs to be made in the documentation of the Pipeline input step plugin and in the online help of the Pipeline input step plugin.

          Mark Waite added a comment - bharath_4232 you are welcome to work on it. The change needs to be made in the documentation of the Pipeline input step plugin and in the online help of the Pipeline input step plugin.

          BHARATH added a comment -

          Thanks, markewaite  
          PR : https://github.com/jenkinsci/pipeline-input-step-plugin/pull/128

          BHARATH added a comment - Thanks, markewaite   PR : https://github.com/jenkinsci/pipeline-input-step-plugin/pull/128
          Mark Waite made changes -
          Status Original: Open [ 1 ] New: In Progress [ 3 ]
          Mark Waite made changes -
          Status Original: In Progress [ 3 ] New: In Review [ 10005 ]
          Mark Waite made changes -
          Remote Link New: This issue links to "PR-128 to improve phrasing of Pipeline input step help (Web Link)" [ 28561 ]

            bharath_4232 BHARATH
            teilo James Nord
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: