doc/dev/coding_standards_css.rst
author Laurent Peuch <cortex@worlddomination.be>
Mon, 22 Jul 2019 11:21:10 +0200
changeset 12696 eb83daa69495
parent 12370 b3084ae2e718
permissions -rw-r--r--
[cubicweb-ctl] respect sys.exit status code when aborting a command When exploring the stack of all calls to a cubicweb-ctl command, it has been discovered than on a KeyboardInterrupt and on a SystemExit exception the base class InstanceCommand (for commands that works on one instance) will always set the return code of cubicweb-ctl to 8: this mean that if another command do a `sys.exit(some_code)` the exit code will be ignored and overwritten by '8'. This behavior is not intuitive, apparently not documented and doesn't seems to have any justification. It also prevent commands from exciting with different return codes which could be a desired behavior in the situation of scripting.

CSS Coding Standards
--------------------

(Draft, to be continued)

:Naming: camelCase

Indentation rules
~~~~~~~~~~~~~~~~~

- 2 spaces before properties

- no space before ":", one space after

- only one space between values of the same property


Documentation
~~~~~~~~~~~~~
Please keep rules semantically linked grouped together, with a comment about
what they are for.

Recommendation
~~~~~~~~~~~~~~
- Try to use existing classes rather than introduce new ones

- Keep things as simple as possible while in the framework

- Think about later customization by application

- Avoid introducing a new CSS file for a few lines of CSS, at least while the
  framework doesn't include packing functionalities