Differential D445

fixing width and improper colon use in distgit directive docs
ClosedPublic
Actions

Authored by tflink on Jul 15 2015, 4:57 PM.

Tags

None

Subscribers

jskladan, mkrizek, tflink

Details

Reviewers

Commits

rLTRN6b24b3d8fffc: fixing width and improper colon use in distgit directive docs
rLTRNbf5d10ed42ae: Merge branch 'develop' into 'master' for 0.3.17 release

Summary

the docs weren't building due to improper colon use and the line length was too long. fixed both issues so that docs are OK and build for release

Test Plan

build docs, it works

Diff Detail

Repository

rLTRN libtaskotron

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

tflink retitled this revision from to fixing width and improper colon use in distgit directive docs.Jul 15 2015, 4:57 PM

tflink updated this object.

tflink edited the test plan for this revision. (Show Details)

tflink added a reviewer: kparal.

tflink added subscribers: mkrizek, jskladan.

Herald added a subscriber: tflink. · View Herald TranscriptJul 15 2015, 4:57 PM

kparal accepted this revision.Jul 15 2015, 5:02 PM

This revision is now accepted and ready to land.Jul 15 2015, 5:02 PM

Closed by commit rLTRN6b24b3d8fffc: fixing width and improper colon use in distgit directive docs (authored by tflink). · Explain WhyJul 15 2015, 5:05 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents

			Path	Packages
M			libtaskotron/directives/distgit_directive.py (19 lines)

Diff 1182

libtaskotron/directives/distgit_directive.py

1	# -- coding: utf-8 --	1		# -- coding: utf-8 --
2	# Copyright 2009-2015, Red Hat, Inc.	2		# Copyright 2009-2015, Red Hat, Inc.
3	# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>	3		# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4	# See the LICENSE file for more details on Licensing	4		# See the LICENSE file for more details on Licensing
5		5
6	from __future__ import absolute_import	6		from __future__ import absolute_import
7		7
8	DOCUMENTATION = """	8		DOCUMENTATION = """
9	module: distgit_directive	9		module: distgit_directive
10	short_description: download files from distgit	10		short_description: download files from distgit
11	description: \|	11		description: \|
12	Download files from Fedora package repository (usually called 'distgit') hosted at http://pkgs.fedoraproject.org/. Any files hosted at that repository can be downloaded for a chosen package.	12		Download files from Fedora package repository (usually called 'distgit') hosted at
		13		http://pkgs.fedoraproject.org/. Any files hosted at that repository can be downloaded for a
		14		chosen package.
13	parameters:	15		parameters:
14	package:	16		package:
15	required: true	17		required: true
16	description: N(E)VR of a package. Package' dist tag determines the git branch used for file download. Example: ``xchat-2.8.8-21.fc20``	18		description: \|
		19		N(E)VR of a package. Package dist tag determines the git branch used for file download.
		20		Example: ``xchat-2.8.8-21.fc20``
17	type: str	21		type: str
18	path:	22		path:
19	required: true	23		required: true
20	description: files (directories not supported at the moment) to be downloaded from distgit. Example: ``[xchat.spec]``	24		description: \|
		25		files (directories not supported at the moment) to be downloaded from distgit.
		26		Example: ``[xchat.spec]``
21	type: list of str	27		type: list of str
22	localpath:	28		localpath:
23	required: false	29		required: false
24	description: a local path of downloaded file. If not provided, path from distgit will be used. Example: ``[specs/xchat.spec]``	30		description: \|
		31		a local path of downloaded file. If not provided, path from distgit will be used.
		32		Example: ``[specs/xchat.spec]``
25	type: list of str	33		type: list of str
26	target_dir:	34		target_dir:
27	required: false	35		required: false
28	description: directory into which to download files	36		description: directory into which to download files
29	type: str	37		type: str
30	default: ${workdir}	38		default: ${workdir}
31	returns: \|	39		returns: \|
32	A dictionary containing following items:	40		A dictionary containing following items:
33		41
34	* `downloaded_files`: (list of str) a list of local filenames of the downloaded	42		* `downloaded_files`: (list of str) a list of local filenames of the downloaded
35	files	43		files
36	raises: \|	44		raises: \|
37	* :class:`.TaskotronRemoteError`: if downloading failed	45		* :class:`.TaskotronRemoteError`: if downloading failed
38	* :class:`.TaskotronValueError`: if path and localpath are not lists or are not of the same length	46		* :class:`.TaskotronValueError`: if path and localpath are not lists or are not of the same
		47		length
39	* :class:`.TaskotronDirectiveError`: if package or path is missing	48		* :class:`.TaskotronDirectiveError`: if package or path is missing
40	version_added: 0.3.16	49		version_added: 0.3.16
41	"""	50		"""
42		51
43	EXAMPLES = """	52		EXAMPLES = """
44	A task needs to download a spec file and httpd configuration check to run a check	53		A task needs to download a spec file and httpd configuration check to run a check
45	on those files::	54		on those files::
46		55
▲ Show 20 Lines • Show All 75 Lines • Show Last 20 Lines