Documentation

Author: Nicolas Lenselle

README.fr.md

@@ -124,9 +124,9 @@ request = api.siret('39860733300059', champs=champs)
 
 |Type|Description|Exemple|
 |----|-----------|-------|
-|FieldExact| Recherche la valeur exact|```FieldExact('demoninationUniteLegale','LE TIMBRE'))```|
-|Periodic| Recherche sur un champ périodique|```Periodic(Field('activitePrincipaleUniteLegale','84.23Z') | Field('activitePrincipaleUniteLegale','86.21Z')))```|
-|Range| Recherche sur un interval|```Range('nomUsageUniteLegale', 'DUPONT', 'DURANT')```|
+|FieldExact| Recherche la valeur exact|FieldExact('demoninationUniteLegale','LE TIMBRE'))|
+|Periodic| Recherche sur un champ périodique|Periodic(Field('activitePrincipaleUniteLegale','84.23Z') | Field('activitePrincipaleUniteLegale','86.21Z')))|
+|Range| Recherche sur un interval|Range('nomUsageUniteLegale', 'DUPONT', 'DURANT')|
 
 ----------------
 

README.md

@@ -128,9 +128,9 @@ data = api.siren(q=-Field('codeCommuneEtablissement', 92046)).get()
 
 |Type|Description|Example|
 |----|-----------|-------|
-|FieldExact| Search on an exact value |```FieldExact('demoninationUniteLegale','LE TIMBRE'))```|
-|Periodic| Search on periodic field |```Periodic(Field('activitePrincipaleUniteLegale','84.23Z') | Field('activitePrincipaleUniteLegale','86.21Z')))```|
-|Range| Search in a range of values |```Range('nomUsageUniteLegale', 'DUPONT', 'DURANT')```|
+|FieldExact| Search on an exact value |FieldExact('demoninationUniteLegale','LE TIMBRE'))|
+|Periodic| Search on periodic field |Periodic(Field('activitePrincipaleUniteLegale','84.23Z') | Field('activitePrincipaleUniteLegale','86.21Z')))|
+|Range| Search in a range of values |Range('nomUsageUniteLegale', 'DUPONT', 'DURANT')|
 
 ----------------
 

README.rst

@@ -142,36 +142,30 @@ Special Search
 +-------+--------------+----------+
 | Type  | Description  | Example  |
 +=======+==============+==========+
-| Field | Search on an | ``FieldE |
-| Exact | exact value  | xact('de |
-|       |              | moninati |
-|       |              | onUniteL |
-|       |              | egale',' |
-|       |              | LE TIMBR |
-|       |              | E'))``   |
+| Field | Search on an | FieldExa |
+| Exact | exact value  | ct('demo |
+|       |              | nination |
+|       |              | UniteLeg |
+|       |              | ale','LE |
+|       |              | TIMBRE') |
+|       |              | )        |
 +-------+--------------+----------+
-| Perio | Search on    | ``Period |
-| dic   | periodic     | ic(Field |
-|       | field        | ('activi |
-|       |              | tePrinci |
-|       |              | paleUnit |
-|       |              | eLegale' |
-|       |              | ,'84.23Z |
-|       |              | ') | Fie |
-|       |              | ld('acti |
-|       |              | vitePrin |
-|       |              | cipaleUn |
-|       |              | iteLegal |
-|       |              | e','86.2 |
-|       |              | 1Z')))`` |
+| Perio | Search on    | Periodic |
+| dic   | periodic     | (Field(' |
+|       | field        | activite |
+|       |              | Principa |
+|       |              | leUniteL |
+|       |              | egale',' |
+|       |              | 84.23Z') |
 +-------+--------------+----------+
-| Range | Search in a  | ``Range( |
-|       | range of     | 'nomUsag |
-|       | values       | eUniteLe |
-|       |              | gale', ' |
-|       |              | DUPONT', |
-|       |              |  'DURANT |
-|       |              | ')``     |
+| Range | Search in a  | Range('n |
+|       | range of     | omUsageU |
+|       | values       | niteLega |
+|       |              | le',     |
+|       |              | 'DUPONT' |
+|       |              | ,        |
+|       |              | 'DURANT' |
+|       |              | )        |
 +-------+--------------+----------+
 
 --------------