Skip to content

Update examples - #18

Open
andruhovski wants to merge 2 commits into
mainfrom
update-examples
Open

andruhovski wants to merge 2 commits into
mainfrom
update-examples

Conversation

@andruhovski

Copy link
Copy Markdown
Contributor

No description provided.

Introduces a new parsing example for extracting XFA field data (`example_parsing_xfa.py`) and adds `sample-xfa.pdf` under sample input data. Also updates several existing examples with small behavior and clarity improvements: PDF/A validation now reports pass/fail, fillable PDF flattening uses `document.flatten()`, RTL text example sets document direction, and minor wording/formatting cleanups were applied. JetBrains `.idea` project files were added as part of this changeset.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

It adds IDE-specific .idea metadata (including machine-specific paths/JDK settings) which should be removed from version control and ignored at the repo root.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates the repository’s documentation and Python example scripts, mainly refining example behavior/output and adding a new parsing example.

Changes:

  • Refined README formatting and wording (table formatting, HTML-to-PDF steps list, minor text tweaks).
  • Updated examples to adjust PDF validation output, flattening behavior, and RTL document direction handling.
  • Added a new XFA parsing example and included JetBrains .idea project metadata files.
File summaries
File Description
README.md Updates table formatting, centering markup, and minor documentation text.
examples/working_with_text/example_text_adding.py Sets document RTL direction before saving in the RTL text example.
examples/working_with_documents/example_manipulate_pdf_document.py Prints PDF/A validation result and switches form flattening to document.flatten().
examples/parsing/example_parsing_xfa.py Adds a new example for extracting XFA form field info.
examples/parsing/example_parsing_acroforms.py Removes an extra blank line.
examples/convert_pdf_document/example_html_to_pdf.py Improves docstring wording for the unimplemented web-page conversion stub.
examples/accessibility_tagged_pdf/example_tagged_pdf_extract.py Clarifies a comment (“pdf” → “PDF”).
.idea/vcs.xml Adds IDE VCS mappings metadata.
.idea/modules.xml Adds IDE modules metadata.
.idea/misc.xml Adds IDE JDK/project settings metadata.
.idea/Aspose.PDF-for-Python-via-.NET.iml Adds IDE module file (includes machine-specific SDK path).
.idea/.gitignore Adds IDE-local ignore rules within .idea.
Review details

Files not reviewed (5)

  • .idea/.gitignore: Generated file
  • .idea/Aspose.PDF-for-Python-via-.NET.iml: Generated file
  • .idea/misc.xml: Generated file
  • .idea/modules.xml: Generated file
  • .idea/vcs.xml: Generated file
  • Files reviewed: 7/13 changed files
  • Comments generated: 3
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +5 to +9
<content url="file://$MODULE_DIR$">
<excludeFolder url="file://$MODULE_DIR$/.venv" />
</content>
<orderEntry type="jdk" jdkName="E:\Github\Aspose.PDF-for-Python-via-.NET\.venv" jdkType="Python SDK" />
<orderEntry type="sourceFolder" forTests="false" />
Comment thread .idea/misc.xml
Comment on lines +1 to +5
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectRootManager" version="2" project-jdk-name="openjdk-26" project-jdk-type="JavaSDK">
<output url="file://$PROJECT_DIR$/out" />
</component>
Comment thread README.md
| [sample_data](sample_data) | A collection of test data for running Python examples. |

<p align="center">
<p style="text-align: center">
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants