openstack/cinder
Code Issues Proposed changes

Fix description for "Barbarism of editting a file"

Browse Source 
There are some barbarism located in the file cinder/HACKING.rst.
  line11 and line21 : there is no full point at the end of a sentence.
  line14 and line23 : after a sentence, there are two space between
  the full point and the first letter of the second sentence.
I think the correct format of the above question as blow.
   - [N319] Validate that debug level logs are not translated.
   - [C302] six.text_type should be used instead of unicode.
   - [N325] str() and unicode() cannot be used on
   an exception. Remove or use six.text_type().
   - [C304] Enforce no use of LOG.audit
   messages. LOG.info should be used instead.

Change-Id: I2896bacc5379786ed115d47e520bf5bc2af0028a
Closes-Bug: #1487665
This commit is contained in:
JuPing 2015-08-22 07:45:47 +00:00
parent fbc59713eb
commit a69d5fffb5
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
HACKING.rst
View File

@ -8,19 +8,19 @@ Cinder Style Commandments
Cinder Specific Commandments Cinder Specific Commandments
---------------------------- ----------------------------
- [N314] Check for vi editor configuration in source files. - [N314] Check for vi editor configuration in source files.
- [N319] Validate that debug level logs are not translated - [N319] Validate that debug level logs are not translated.
- [N322] Ensure default arguments are not mutable. - [N322] Ensure default arguments are not mutable.
- [N323] Add check for explicit import of _() to ensure proper translation. - [N323] Add check for explicit import of _() to ensure proper translation.
- [N325] str() and unicode() cannot be used on an exception. Remove or use six.text_type(). - [N325] str() and unicode() cannot be used on an exception. Remove or use six.text_type().
- [N328] LOG.info messages require translations `_LI()`. - [N328] LOG.info messages require translations `_LI()`.
- [N329] LOG.exception and LOG.error messages require translations `_LE()`. - [N329] LOG.exception and LOG.error messages require translations `_LE()`.
- [N330] LOG.warning messages require translations `_LW()`. - [N330] LOG.warning messages require translations `_LW()`.
- [N333] Ensure that oslo namespaces are used for namespaced libraries. - [N333] Ensure that oslo namespaces are used for namespaced libraries.
- [N336] Must use a dict comprehension instead of a dict constructor with a sequence of key-value pairs. - [N336] Must use a dict comprehension instead of a dict constructor with a sequence of key-value pairs.
- [C301] timeutils.utcnow() from oslo_utils should be used instead of datetime.now(). - [C301] timeutils.utcnow() from oslo_utils should be used instead of datetime.now().
- [C302] six.text_type should be used instead of unicode - [C302] six.text_type should be used instead of unicode.
- [C303] Ensure that there are no 'print()' statements in code that is being committed. - [C303] Ensure that there are no 'print()' statements in code that is being committed.
- [C304] Enforce no use of LOG.audit messages. LOG.info should be used instead. - [C304] Enforce no use of LOG.audit messages. LOG.info should be used instead.
- [C305] Prevent use of deprecated contextlib.nested. - [C305] Prevent use of deprecated contextlib.nested.
- [C306] timeutils.strtime() must not be used (deprecated). - [C306] timeutils.strtime() must not be used (deprecated).
- [C307] LOG.warn is deprecated. Enforce use of LOG.warning. - [C307] LOG.warn is deprecated. Enforce use of LOG.warning.