<commit_before>.. cantools documentation master file, created by
   sphinx-quickstart on Sat Apr 25 11:54:09 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 2

CAN BUS tools
=============

.. include:: ../README.rst

Functions and classes
=====================

.. autofunction:: cantools.db.load_file

.. autofunction:: cantools.db.load_string

.. autofunction:: cantools.db.load

.. autoclass:: cantools.db.Database
    :members:

.. autoclass:: cantools.db.Message
    :members:

.. autoclass:: cantools.db.Signal
    :members:

.. autoclass:: cantools.db.UnsupportedDatabaseFormatError
    :members:

.. autoclass:: cantools.tester.Tester
    :members:

.. autoclass:: cantools.tester.DecodedMessage

   .. data:: name

      Message name.

   .. data:: signals

      Message signals.

Coding style
============

The coding style for this package is defined as below. The rules are
based on my personal preference.

- Blank lines before and after statements (if, while, return, ...)
  (1).

- Two blank lines between file level definitions (2).

- Space before and after operators (3), except for keywork arguments
  where no space is allowed (4).

- One import per line (5).

- Comments and doc strings starts with capital letter and ends with a
  period, that is, just as sentences (6).

- Blank line after doc strings (7).

- Maximum line length of 90 characters, but aim for less than 80.
  
  .. code-block:: python

     import sys
     from os import path                   # (5)
     from os import getcwd                 # (5)
                                           # (2)
                                           # (2)
     def foo(bars, fum=None):              # (4)
         """This is a doc string.          # (6)

         """<commit_msg>Function arguments coding style rule.<commit_after>.. cantools documentation master file, created by
   sphinx-quickstart on Sat Apr 25 11:54:09 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 2

CAN BUS tools
=============

.. include:: ../README.rst

Functions and classes
=====================

.. autofunction:: cantools.db.load_file

.. autofunction:: cantools.db.load_string

.. autofunction:: cantools.db.load

.. autoclass:: cantools.db.Database
    :members:

.. autoclass:: cantools.db.Message
    :members:

.. autoclass:: cantools.db.Signal
    :members:

.. autoclass:: cantools.db.UnsupportedDatabaseFormatError
    :members:

.. autoclass:: cantools.tester.Tester
    :members:

.. autoclass:: cantools.tester.DecodedMessage

   .. data:: name

      Message name.

   .. data:: signals

      Message signals.

Coding style
============

The coding style for this package is defined as below. The rules are
based on my personal preference.

- Blank lines before and after statements (if, while, return, ...)
  (1).

- Two blank lines between file level definitions (2).

- Space before and after operators (3), except for keywork arguments
  where no space is allowed (4).

- One import per line (5).

- Comments and doc strings starts with capital letter and ends with a
  period, that is, just as sentences (6).

- Blank line after doc strings (7).

- Maximum line length of 90 characters, but aim for less than 80.

- All function arguments on one line, or one per line.

  .. code-block:: python

     import sys
     from os import path                   # (5)
     from os import getcwd                 # (5)
                                           # (2)
                                           # (2)
     def foo(bars, fum=None):              # (4)
         """This is a doc string.          # (6)

         """
{'fraction_non_alphanumeric': 0.11916010498687664, 'fraction_numerical': 0.015748031496062992, 'mean_word_length': 2.2628424657534247, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '566873', 'n_tokens_mistral': 1125, 'n_tokens_neox': 1047, 'n_words': 408}