Skip to content

Fix NodeDriver.get_image docstring - #2180

Open
nightcityblade wants to merge 1 commit into
apache:trunkfrom
nightcityblade:docs/issue-1540
Open

Fix NodeDriver.get_image docstring#2180
nightcityblade wants to merge 1 commit into
apache:trunkfrom
nightcityblade:docs/issue-1540

Conversation

@nightcityblade

Copy link
Copy Markdown

Fix NodeDriver.get_image docstring

Description

Correct the NodeDriver.get_image() documentation so image_id is described as an image identifier instead of a node. Also fix the malformed :rtype: field so Sphinx renders the NodeImage return type correctly.

Fixes #1540.

Status

  • done, ready for review

Checklist (tick everything that applies)

  • Code linting (required, can be done after the PR checks)
  • Documentation
  • Tests
  • ICLA (required for bigger changes) — N/A for this documentation-only correction.

Signed-off-by: nightcityblade <nightcityblade@gmail.com>
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 docstring for get_image()

1 participant