Commits

while0pass committed f06f1a7

Mark some inline literal text.

Comments (0)

Files changed (1)

docs/source/schema.rst

     If your users will use the keyword field for searching, use ``scorable=True``.
 
 :class:`whoosh.fields.ID`
-    The ID field type simply indexes (and optionally stores) the entire value of
+    The ``ID`` field type simply indexes (and optionally stores) the entire value of
     the field as a single unit (that is, it doesn't break it up into individual
     terms). This type of field does not store frequency information, so it's
     quite compact, but not very useful for scoring.
 
-    Use ID for fields like url or path (the URL or file path of a document),
+    Use ``ID`` for fields like url or path (the URL or file path of a document),
     date, category -- fields where the value must be treated as a whole, and
     each document only has one value for the field.
 
-    By default, ID fields are not stored. Use ID(stored=True) to specify that
+    By default, ``ID`` fields are not stored. Use ``ID(stored=True)`` to specify that
     the value of the field should be stored with the document for use in the
     search results. For example, you would want to store the value of a url
     field so you could provide links to the original in your search results.
                     tags=KEYWORD)
 
 If you aren't specifying any constructor keyword arguments to one of the
-predefined fields, you can leave off the brackets (e.g. fieldname=TEXT instead
-of fieldname=TEXT()). Whoosh will instantiate the class for you.
+predefined fields, you can leave off the brackets (e.g. ``fieldname=TEXT`` instead
+of ``fieldname=TEXT()``). Whoosh will instantiate the class for you.
 
 Alternatively you can create a schema declaratively using the ``SchemaClass``
 base class::
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.