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

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

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • Minor
    • None
    • None
    • DevTools
    • None

    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_rust_toolset.adoc
       19:7     error  Consider using 'create a        IBM.terms 
                       version or assign a version               
                       number' instead of 'Version'              
       43:306   error  Consider using 'type or press'  IBM.terms 
                       instead of 'key'                          
       68:18    error  Consider using 'type or press'  IBM.terms 
                       instead of 'key'                          
       83:12    error  Consider using 'information     IBM.terms 
                       about' instead of 'information            
                       on'                                       
       117:108  error  Consider using 'complete or     IBM.terms 
                       perform' instead of 'do'                  
       167:81   error  Consider using 'create a        IBM.terms 
                       version or assign a version               
                       number' instead of 'version'              
       210:41   error  Consider using 'rather than'    IBM.terms 
                       instead of 'instead of'                   
       960:86   error  Consider using 'information     IBM.terms 
                       about' instead of 'information            
                       on'                                       
       960:147  error  Consider using 'create a        IBM.terms 
                       version|assign a version                  
                       number' instead of 'version'              
       1005:74  error  Consider using 'information     IBM.terms 
                       about' instead of 'information            
                       on'                                       
       1066:57  error  Consider using 'rather than'    IBM.terms 
                       instead of 'instead of'                   
       1141:13  error  Consider using 'create a        IBM.terms 
                       version or assign a version               
                       number' instead of 'Version'              
       1169:38  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: