Skip to content

Fix Google DNS bulk record docstring syntax - #2182

Open
nightcityblade wants to merge 1 commit into
apache:trunkfrom
nightcityblade:fix/issue-1936-docstring-syntax
Open

Fix Google DNS bulk record docstring syntax#2182
nightcityblade wants to merge 1 commit into
apache:trunkfrom
nightcityblade:fix/issue-1936-docstring-syntax

Conversation

@nightcityblade

Copy link
Copy Markdown

Fix Google DNS bulk record docstring syntax

Description

Fixes #1936.

The GoogleDNSDriver.ex_bulk_record_changes docstring mixed a field-list
continuation with an unmarked, inconsistently indented dictionary example.
Sphinx/docutils therefore emitted three warnings while generating the API
documentation. This change aligns the continued parameter description and
marks the example as a Python code block, without changing runtime behavior.

Status

Done, ready for review.

Checklist (tick everything that applies)

  • Code linting (flake8 and Black check pass)
  • Documentation (Sphinx 6.2.1 dummy build passes; the three warnings for this docstring are gone)
  • Tests (11 passed in libcloud/test/dns/test_google.py)
  • ICLA (N/A; small documentation-only correction)

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.

Fix syntax issues in docstrings in the code

1 participant