Bug 769438

Summary: [PATCH] Fix syntax of code examples within rpm-guide-programming-python.xml
Product: [Fedora] Fedora Documentation Reporter: Dave Malcolm <dmalcolm>
Component: rpm-guideAssignee: Ben Cotton <bcotton>
Status: CLOSED WONTFIX QA Contact: Fedora Docs QA <docs-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: develCC: pkovar, zach
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-12-14 10:30:23 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
Patch to Rpm Guide to fix rpm-guide-programming-python.xml none

Description Dave Malcolm 2011-12-20 20:37:40 UTC
Created attachment 548940 [details]
Patch to Rpm Guide to fix rpm-guide-programming-python.xml

Unfortunately the examples of Python code within the RPM guide have been thoroughly broken since the initial conversion to DocBook, due to the way Python treats leading whitespace as significant.

I'm attaching a patch which overhauls this page, so that the code examples are syntactically valid.  See the notes in the patch

Comment 1 Dave Malcolm 2011-12-20 20:38:42 UTC
Note: bugzilla is mangling the patch somewhat.  Use the "raw" viewing mode aka:
  https://bugzilla.redhat.com/attachment.cgi?id=548940
to see the additional notes at the top of the patch.

Comment 2 Ben Cotton 2011-12-20 21:18:00 UTC
Patch committed.

Comment 3 Dave Malcolm 2012-04-17 18:01:15 UTC
Has the html been regenerated yet?

When I google for "rpm python api docs" it takes me to:
http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/index.html

and these have the old, broken version of the python api docs.

Comment 4 Ben Cotton 2012-04-17 18:11:05 UTC
The HTML has not been regenerated yet, I'll try to get to that shortly.

Comment 5 Petr Kovar 2017-12-14 10:30:23 UTC
The RPM Guide has been deprecated in favor of https://rpm-packaging-guide.github.io/.

Closing the issue here.