nuttx-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [incubator-nuttx] patacongo opened a new pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Date Wed, 20 May 2020 00:36:05 GMT

patacongo opened a new pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083


   ## Summary
   
   Documentation/NuttXCCodingStandard.html:
     - Fix a typo:  "be aligned so that the comment begins in the same comment on each line."
Of course that should have been column.
     - Update a coding standard requirement.  With regard to Comments to the Right of Statements,
the document said:  "If such comments are used, they should ... fit on one line."  This is
not true any more.  In common practice (include the checks in nxstyle), comments to the right
of statements may be continued to the following line.  The standard way of continuing such
comments was also documented.
   
   Documents/style.css:  It appears that a varible with font was being used for \<pre\>
and \<code\>, that was really screwing up the presentation, especially in the coding
standared where there are many examples illustrating correct vertical alignment.  The font
type "Bitstream Vera Sans Mono" was replaced with "courier" for \<pre\> and \<code\>
   
   ## Impact
   
   None
   
   ## Testing
   
   N/A
   
   
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message