while0pass committed 6fa0833

A Space and some literal text

Comments (0)

Files changed (1)


 a given "glob" (a name pattern containing ``*``, ``?``, and/or ``[abc]``
-You can add dynamic fields to a new schema using the add() method with the
+You can add dynamic fields to a new schema using the ``add()`` method with the
 ``glob`` keyword set to True::
     schema = fields.Schema(...)
 For example, to allow documents to contain any field name that ends in ``_id``
-and associate it with the ID field type::
+and associate it with the ``ID`` field type::
     schema = fields.Schema(path=fields.ID)
     schema.add("*_id", fields.ID, glob=True)
                              on disk.
 vector       fields.Format   Optional: if defined, the format in which to store
                              per-document forward-index information for this field.
-scorable     bool            If True, the length of (number of terms in)the field in
+scorable     bool            If True, the length of (number of terms in) the field in
                              each document is stored in the index. Slightly misnamed,
                              since field lengths are not required for all scoring.
                              However, field lengths are required to get proper
                 and at what positions.
 =============== ================================================================
-The STORED field type uses the Stored format (which does nothing, so STORED
-fields are not indexed). The ID type uses the Existence format. The KEYWORD type
-uses the Frequency format. The TEXT type uses the Positions format if it is
-instantiated with phrase=True (the default), or Frequency if phrase=False.
+The ``STORED`` field type uses the ``Stored`` format (which does nothing, so ``STORED``
+fields are not indexed). The ``ID`` type uses the ``Existence`` format. The ``KEYWORD`` type
+uses the ``Frequency`` format. The ``TEXT`` type uses the ``Positions`` format if it is
+instantiated with ``phrase=True`` (the default), or ``Frequency`` if ``phrase=False``.
 In addition, the following formats are implemented for the possible convenience
 of expert users, but are not currently used in Whoosh: