Skip to content

docs: correct copy-pasted comments in docker client helpers - #1295

Merged
0xfornax merged 1 commit into
rocket-pool:masterfrom
elonfliter:master
Oct 19, 2026
Merged

0xfornax merged 1 commit into
rocket-pool:masterfrom
elonfliter:master

Conversation

@elonfliter

Copy link
Copy Markdown
Contributor

Two more doc comments are left over from the function above them and describe
the wrong thing.

  • shared/services/rocketpool/client.go:568 — Client.GetDockerStatus was
    documented as "Get the current Docker image used by the given container", a
    verbatim copy of the comment on GetDockerImage at line 555. It now reads
    "Get the current Docker status of the given container", which matches the
    command it runs (docker container inspect --format={{.State.Status}}).
  • shared/services/rocketpool/client.go:717 — Client.DeleteVolume was
    documented as "Deletes a container", a verbatim copy of the comment on
    RemoveContainer at line 705. It now reads "Deletes a docker volume",
    matching the command it runs (docker volume rm) and the wording of
    DeleteDockerImage immediately below it.

Signed-off-by: elonfliter <elonfliter@outlook.com>
@0xfornax
0xfornax merged commit 8b857c8 into rocket-pool:master Oct 19, 2026
6 checks passed
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