opendev/subunit2sql
Code Issues Proposed changes

Merge "Fix misspelled words in some docs"

Browse Source
This commit is contained in:
Jenkins 2015-06-30 02:46:37 +00:00 committed by Gerrit Code Review
commit 441612b759
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/api.rst
View File

@ -10,7 +10,7 @@ DB API Guide
Example usage patterns Example usage patterns
---------------------- ----------------------
Initiallizing subunit2sql Initializing subunit2sql
````````````````````````` `````````````````````````
The first step to using subunit2sql inside your program is to initialize the db The first step to using subunit2sql inside your program is to initialize the db

2
doc/source/data_model.rst
View File

@ -68,7 +68,7 @@ Properties:
Attachments Attachments
----------- -----------
Attachemnts represent the file attachemnts in the subunit stream for a Attachments represent the file attachments in the subunit stream for a
particular test_run. particular test_run.
Properties: Properties:

8
doc/source/graph.rst
View File

@ -1,6 +1,6 @@
Subunit2SQL Graphs Subunit2SQL Graphs
================== ==================
subunit2sql includes a utilty to generate various graphs from the data in a subunit2sql includes a utility to generate various graphs from the data in a
database. This is used to provide a more visual analysis of the data contained database. This is used to provide a more visual analysis of the data contained
in the DB. in the DB.
@ -128,14 +128,14 @@ graph commands are too application specific to be in the general purpose
command, or really any reason. command, or really any reason.
A graph plugin is simply a python module that has of a few pieces: a A graph plugin is simply a python module that has of a few pieces: a
set_cli_opts function, a generate_series function, and a a python entrypoint. set_cli_opts function, a generate_series function, and a python entrypoint.
This is the same as the internal interface for the in-tree commands, meaning This is the same as the internal interface for the in-tree commands, meaning
that migrating a command from landing in the upstream repo and as an external that migrating a command from landing in the upstream repo and as an external
plugin is quite straightforward. plugin is quite straightforward.
Entry Point Entry Point
----------- -----------
This is how you tell the subunit2sql-graph command about the existance of the This is how you tell the subunit2sql-graph command about the existence of the
external plugin. It leverages setuptools and stevedore to register the module external plugin. It leverages setuptools and stevedore to register the module
in a known namespace which will be loaded by the subunit2sql-graph command. in a known namespace which will be loaded by the subunit2sql-graph command.
@ -182,7 +182,7 @@ Simply add it and make it a no-op, for example::
def set_cli_opts(parser): def set_cli_opts(parser):
pass pass
The normal way this is used is to add args is to just call add_argunment on the The normal way this is used is to add args is to just call add_argument on the
parser passed in. For example, to add a single option, test_id, you would do parser passed in. For example, to add a single option, test_id, you would do
the following:: the following::