Skip to content

Commit

Permalink
.rst markup fixes (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmalcolm committed Mar 31, 2017
1 parent d0174dd commit 4791ee1
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions docs/data-model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ Firehose XML document.
'http://cwe.mitre.org/data/definitions/131.html'


.. py:class:: Info(Result)
.. py:class:: Info(Result)
An :py:class:`Info` represents additional kinds of information
generated by an analyzer that isn't a problem per-se e.g.
Expand Down Expand Up @@ -267,7 +267,7 @@ Firehose XML document.
self.customfields = customfields

.. py:class:: Failure(Result)
.. py:class:: Failure(Result)
A :py:class:`Failure` represents a report about a failure of the
analyzer itself (e.g. if the analyzer crashed).
Expand Down Expand Up @@ -357,11 +357,11 @@ Metadata

.. py:attribute:: sut
py:class:`Sut` or ``None``
:py:class:`Sut` or ``None``

.. py:attribute:: file_
py:class:`File` or ``None``
:py:class:`File` or ``None``

.. py:attribute:: stats
Expand All @@ -381,7 +381,7 @@ Metadata
self.file_ = file_
self.stats = stats
.. py:class:: Generator
.. py:class:: Generator
.. py:attribute:: name
Expand All @@ -391,7 +391,7 @@ Metadata
``str`` or ``None``

.. py:class:: Stats
.. py:class:: Stats
:py:class:`Stats` is an optional field of :py:class:`Metadata` for
capturing stats about an analysis run.
Expand All @@ -406,11 +406,11 @@ Describing the software under test

.. warning:: this part of the schema may need more thought/work

.. py:class:: Sut:
.. py:class:: Sut
Base class for describing the software-under-test.

.. py:class:: SourceRpm(Sut)
.. py:class:: SourceRpm(Sut)
It corresponds to the ``<source-rpm>`` XML element within
a Firehose XML document.
Expand All @@ -431,7 +431,7 @@ Describing the software under test
``str``

.. py:class:: DebianBinary(Sut)
.. py:class:: DebianBinary(Sut)
Internal Firehose representation of a Debian binary package. This Object
is extremely similar to a SourceRpm.
Expand All @@ -457,7 +457,7 @@ Describing the software under test
``str``: valid entries include ``amd64`', ``kfreebsd-amd64``,
``armhf``, ``hurd-i386``, among others for Debian.

.. py:class:: DebianSource(Sut)
.. py:class:: DebianSource(Sut)
Internal Firehose representation of a Debian source package. This Object
is extremely similar to a SourceRpm, but does not include the `buildarch`
Expand All @@ -481,7 +481,7 @@ Describing the software under test
Debian Native package.


.. py:class:: Message
.. py:class:: Message
Summary text aimed at a developer. This is required for an
:py:class:`Issue`, but is also can (optionally) be provided by
Expand All @@ -495,7 +495,7 @@ Describing the software under test
``str``


.. py:class:: Notes:
.. py:class:: Notes
Additional descriptive details for a :py:class:`Result`.

Expand All @@ -512,7 +512,7 @@ Describing the software under test
Describing source code
**********************

.. py:class:: Location
.. py:class:: Location
A particular source code location.

Expand Down Expand Up @@ -614,7 +614,7 @@ Describing source code
self.abspath = abspath
self.hash_ = hash_
.. py:class:: Hash
.. py:class:: Hash
An optional value within :py:class:`File`, allowing the report to
specify a hash value for a particular file.
Expand Down Expand Up @@ -644,7 +644,7 @@ Describing source code
self.alg = alg
self.hexdigest = hexdigest
.. py:class:: Function
.. py:class:: Function
Identification of a particular function within source code.

Expand All @@ -659,7 +659,7 @@ Describing source code
def __init__(self, name):
self.name = name
.. py:class:: Point
.. py:class:: Point
Identification of a particular line/column within a source file.

Expand All @@ -674,7 +674,7 @@ Describing source code
(``int``)

.. py:class:: Range
.. py:class:: Range
Identification of a range of text within a source file.

Expand All @@ -692,7 +692,7 @@ Describing source code
Capturing the circumstances leading up to a problem
***************************************************

.. py:class:: Trace
.. py:class:: Trace
An optional list of events within an :py:class:`Issue` that describe
the circumstances leading up to a problem.
Expand All @@ -706,7 +706,7 @@ Capturing the circumstances leading up to a problem
list of :py:class:`State`

.. py:class:: State
.. py:class:: State
.. py:attribute:: location
Expand Down

0 comments on commit 4791ee1

Please sign in to comment.