Skip to content

Fix RST docstring indentation errors in documentation build#505

Draft
cleder with Copilot wants to merge 3 commits into
developfrom
copilot/fix-documentation-indentation-errors
Draft

Fix RST docstring indentation errors in documentation build#505
cleder with Copilot wants to merge 3 commits into
developfrom
copilot/fix-documentation-indentation-errors

Conversation

Copilot AI commented May 1, 2026

Copy link
Copy Markdown
Contributor

Three docstrings caused ERROR: Unexpected indentation when building docs, because RST processed them as raw markup (Napoleon's Args:\n---- hybrid format is unrecognized, passing through unchanged).

Changes

  • base.py_XMLObject.etree_element: Flattened a nested sub-bullet (For each attribute: → - Call...) into a single bullet. RST has no blank line before the deeper-indented item, triggering the error.

  • geometry.pycreate_kml_geometry: Fixed altitude_mode continuation line from deep alignment-indent (23 spaces) to the same 8-space level as other params. RST flagged the jump in indentation as an unexpected block.

  • styles.pyPair: Converted a 4-space-indented paragraph directly after <Pair> contains two elements (both are required): into a proper RST bullet list with a preceding blank line.

@semanticdiff-com

semanticdiff-com Bot commented May 1, 2026

Copy link
Copy Markdown

Review changes with  SemanticDiff

Changed Files
File Status
  fastkml/styles.py  96% smaller
  fastkml/base.py  85% smaller
  fastkml/geometry.py  0% smaller

@codacy-production

codacy-production Bot commented May 1, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

Copilot AI changed the title [WIP] Fix unexpected indentation errors in documentation Fix RST docstring indentation errors in documentation build May 1, 2026
@github-actions

github-actions Bot commented May 1, 2026

Copy link
Copy Markdown

Preparing review...

1 similar comment
@github-actions

github-actions Bot commented May 1, 2026

Copy link
Copy Markdown

Preparing review...

Copilot finished work on behalf of cleder May 1, 2026 13:23
Copilot AI requested a review from cleder May 1, 2026 13:23

@codescene-access codescene-access Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Our agent can fix these. Install it.

Gates Passed
6 Quality Gates Passed

Quality Gate Profile: Customizable Safeguards
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

@qodo-code-review

Copy link
Copy Markdown

CI Feedback 🧐

A test triggered by this PR failed. Here is an AI-generated analysis of the failure:

Action: SonarCloud

Failed stage: SonarCloud Scan [❌]

Failed test name: ""

Failure summary:

The action failed during the SonarScanner (SonarCloud) analysis step.
- SonarScanner auto-configured
the run for GitHub event pull_request and attempted to fetch PR details for pull request key 505.
-
It then errored with: ERROR Something went wrong while trying to get the pullrequest with key '505',
causing EXECUTION FAILURE and the process to exit with code 3.
- This typically indicates SonarCloud
could not access PR metadata via the GitHub/SonarCloud integration (e.g., missing/insufficient
permissions for the token, or a problem with the ALM binding / PR decoration configuration).

Relevant error logs:
1:  ##[group]Runner Image Provisioner
2:  Hosted Compute Agent
...

109:  Removing includeIf entries pointing to credentials config files
110:  [command]/usr/bin/git config --local --name-only --get-regexp ^includeIf\.gitdir:
111:  [command]/usr/bin/git submodule foreach --recursive git config --local --show-origin --name-only --get-regexp remote.origin.url
112:  [command]/usr/bin/git config --file /home/runner/work/_temp/git-credentials-2ac9ecf7-5bf1-4aa1-9fac-86525358210e.config http.https://github.com/.extraheader AUTHORIZATION: basic ***
113:  [command]/usr/bin/git config --local includeIf.gitdir:/home/runner/work/fastkml/fastkml/.git.path /home/runner/work/_temp/git-credentials-2ac9ecf7-5bf1-4aa1-9fac-86525358210e.config
114:  [command]/usr/bin/git config --local includeIf.gitdir:/home/runner/work/fastkml/fastkml/.git/worktrees/*.path /home/runner/work/_temp/git-credentials-2ac9ecf7-5bf1-4aa1-9fac-86525358210e.config
115:  [command]/usr/bin/git config --local includeIf.gitdir:/github/workspace/.git.path /github/runner_temp/git-credentials-2ac9ecf7-5bf1-4aa1-9fac-86525358210e.config
116:  [command]/usr/bin/git config --local includeIf.gitdir:/github/workspace/.git/worktrees/*.path /github/runner_temp/git-credentials-2ac9ecf7-5bf1-4aa1-9fac-86525358210e.config
117:  ##[endgroup]
118:  ##[group]Fetching the repository
119:  [command]/usr/bin/git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules origin +refs/heads/*:refs/remotes/origin/* +refs/tags/*:refs/tags/* +517df760cc7e996372ccc190e0c9aea39e8cc290:refs/remotes/pull/505/merge
120:  From https://github.com/cleder/fastkml
121:  * [new branch]      317-add-tests-for-the-ogc-kml-22-conformance-test-suite -> origin/317-add-tests-for-the-ogc-kml-22-conformance-test-suite
122:  * [new branch]      copilot/add-update-functionality-networklinkcontrol -> origin/copilot/add-update-functionality-networklinkcontrol
123:  * [new branch]      copilot/broaden-change-registry-coverage -> origin/copilot/broaden-change-registry-coverage
124:  * [new branch]      copilot/fix-documentation-indentation-errors -> origin/copilot/fix-documentation-indentation-errors
125:  * [new branch]      copilot/weekly-code-quality-report-2026-05-31 -> origin/copilot/weekly-code-quality-report-2026-05-31
...

429:  save-always: false
430:  env:
431:  pythonLocation: /opt/hostedtoolcache/Python/3.13.14/x64
432:  PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.13.14/x64/lib/pkgconfig
433:  Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.13.14/x64
434:  Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.13.14/x64
435:  Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.13.14/x64
436:  LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.13.14/x64/lib
437:  GITHUB_TOKEN: ***
438:  SONAR_TOKEN: ***
439:  SEGMENT_DOWNLOAD_TIMEOUT_MINS: 1
440:  ##[endgroup]
441:  (node:2425) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
442:  (Use `node --trace-deprecation ...` to show where the warning was created)
443:  Cache hit for: sonar-scanner-cli-7.0.2.4839-Linux-X64
444:  (node:2425) [DEP0169] DeprecationWarning: `url.parse()` behavior is not standardized and prone to errors that have security implications. Use the WHATWG URL API instead. CVEs are not issued for `url.parse()` vulnerabilities.
445:  Received 0 of 51817846 (0.0%), 0.0 MBs/sec
...

497:  17:08:34.776 INFO  Load/download plugins (done) | time=699ms
498:  17:08:35.051 INFO  Loaded core extensions: architecture, sca, a3s
499:  17:08:35.315 INFO  Process project properties
500:  17:08:35.335 INFO  Project key: cleder_fastkml
501:  17:08:35.336 INFO  Base dir: /home/runner/work/fastkml/fastkml
502:  17:08:35.336 INFO  Working dir: /home/runner/work/fastkml/fastkml/.scannerwork
503:  17:08:35.340 INFO  Load project settings for component key: 'cleder_fastkml'
504:  17:08:35.765 INFO  Load project settings for component key: 'cleder_fastkml' (done) | time=425ms
505:  17:08:35.776 INFO  Found an active CI vendor: 'Github Actions'
506:  17:08:36.187 INFO  Check ALM binding of project 'cleder_fastkml'
507:  17:08:36.461 INFO  Detected project binding: BOUND
508:  17:08:36.461 INFO  Check ALM binding of project 'cleder_fastkml' (done) | time=272ms
509:  17:08:36.465 INFO  Load branch configuration
510:  17:08:36.469 INFO  Github event: pull_request
511:  17:08:36.476 INFO  Auto-configuring pull request 505
512:  17:08:37.108 ERROR Something went wrong while trying to get the pullrequest with key '505'
513:  17:08:37.432 INFO  EXECUTION FAILURE
514:  17:08:37.434 INFO  Total time: 9.412s
515:  ##[error]Process completed with exit code 3.
516:  Post job cleanup.

@codecov

codecov Bot commented Jul 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (cceda15) to head (f8d37af).

Additional details and impacted files
@@            Coverage Diff            @@
##           develop      #505   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           80        80           
  Lines         6579      6579           
  Branches       164       164           
=========================================
  Hits          6579      6579           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

Buildung documentation outputs errors base.py:docstring of fastkml.base._XMLObject.etree_element:9: ERROR: Unexpected indentation. etc.

2 participants