Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-1795

Address forbidden words and expressions or suggestions based on IBM developer styleguide in Go toolset

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • Minor
    • None
    • None
    • DevTools
    • None
    • Documentation (Ref Guide, User Guide, etc.)

    Description

      I would appreciate if you left a comment about how many crude false positives or errors this check includes. (Probably a lot...)

      The check is based on this style: https://www.ibm.com/developerworks/library/styleguidelines/index.html
      First number refers to a line where an error occurs, second number refers to a word in a line.

       docs/topics/using_go_toolset.adoc
       18:7    error  Consider using 'create a        IBM.terms 
                      version or assign a version               
                      number' instead of 'Version'              
       40:306  error  Consider using 'type or press'  IBM.terms 
                      instead of 'key'                          
       53:4    error  Consider using 'suggest'        IBM.terms 
                      instead of 'recommend'                    
       65:18   error  Consider using 'type or press'  IBM.terms 
                      instead of 'key'                          
       80:12   error  Consider using 'information     IBM.terms 
                      about' instead of 'information            
                      on'                                       
       355:52  error  Consider using 'information     IBM.terms 
                      about' instead of 'information            
                      on'                                       
       409:60  error  Consider using 'information     IBM.terms 
                      about' instead of 'information            
                      on'                                       
       446:48  error  Consider using 'rather than'    IBM.terms 
                      instead of 'instead of'                   
       555:72  error  Consider using 'information     IBM.terms 
                      about' instead of 'information            
                      on'                                       
       626:60  error  Consider using 'information     IBM.terms 
                      about' instead of 'information            
                      on'                                       
       641:13  error  Consider using 'create a        IBM.terms 
                      version or assign a version               
                      number' instead of 'Version'              
       677:22  error  Consider using 'complete or     IBM.terms 
                      perform' instead of 'do'                  
       705:10  error  Consider using 'use' instead    IBM.terms 
                      of 'leverage'                             
       729:26  error  Consider using 'create a        IBM.terms 
                      version or assign a version               
                      number' instead of 'version'   
      

      Attachments

        Activity

          People

            Unassigned Unassigned
            yhontyk@redhat.com Yana Hontyk
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: