Skip to content

mgr/orchestrator: Update docstring of service_action method#36373

Merged
sebastian-philipp merged 1 commit intoceph:masterfrom
varshar16:wip-update-orch-doc-str
Aug 7, 2020
Merged

mgr/orchestrator: Update docstring of service_action method#36373
sebastian-philipp merged 1 commit intoceph:masterfrom
varshar16:wip-update-orch-doc-str

Conversation

@varshar16
Copy link
Contributor

@varshar16 varshar16 commented Jul 30, 2020

Signed-off-by: Varsha Rao varao@redhat.com

Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard backend
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox

Comment on lines +959 to +960
:param service_name: service_type (e.g. "mds", "rgw", ...) + name of
logical service ("cephfs", "us-east", ...)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
:param service_name: service_type (e.g. "mds", "rgw", ...) + name of
logical service ("cephfs", "us-east", ...)
:param service_name: (e.g. "mon", "mgr", "mds.mycephfs", "rgw.realm.zone", ...)

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have modified it a bit.

@Devp00l
Copy link

Devp00l commented Aug 3, 2020

Hi I just wondered about your commit description "...n methods" and I though the commit title is so long that github won't show it because of "..." at the end ;) After clicking on the commit present with a view where title and message aren't shown as far apart it was clear to me that it should be displayed together.

That said how about to shorten the message?
Instead of:

mgr/orchestrator: Update docstring of service_action and daemon_actio…

…n methods

How about:

mgr/orchestrator: Updates service_action and daemon_action docstrings

@varshar16 varshar16 force-pushed the wip-update-orch-doc-str branch from 109ee5b to daffec3 Compare August 4, 2020 06:47
@varshar16
Copy link
Contributor Author

Hi I just wondered about your commit description "...n methods" and I though the commit title is so long that github won't show it because of "..." at the end ;) After clicking on the commit present with a view where title and message aren't shown as far apart it was clear to me that it should be displayed together.

That said how about to shorten the message?
Instead of:

mgr/orchestrator: Update docstring of service_action and daemon_actio…

…n methods

How about:

mgr/orchestrator: Updates service_action and daemon_action docstrings

I have updated the commit title.

@varshar16 varshar16 requested a review from Devp00l August 4, 2020 06:52
@sebastian-philipp sebastian-philipp added the wip-swagner-testing My Teuthology tests label Aug 4, 2020
@varshar16
Copy link
Contributor Author

jenkins retest this please

@sebastian-philipp
Copy link
Contributor

Comment on lines +959 to 961
:param service_name: service_type + '.' + service_id
(e.g. "mon", "mgr", "mds.mycephfs", "rgw.realm.zone", ...)
:rtype: Completion
Copy link
Contributor

Choose a reason for hiding this comment

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

/home/jenkins-build/build/workspace/ceph-pr-docs/src/pybind/mgr/orchestrator/_interface.py:docstring of orchestrator.Orchestrator.service_action:8: WARNING: Field list ends without a blank line; unexpected unindent.

https://jenkins.ceph.com/job/ceph-pr-docs/29817/consoleFull#-85362248744e9240e-b50a-4693-bac0-8a991bac86ac

:param daemon_id: Depending on daemon type it can be numerical value or
service name
:rtype: Completion
Copy link
Contributor

Choose a reason for hiding this comment

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

/home/jenkins-build/build/workspace/ceph-pr-docs/src/pybind/mgr/orchestrator/_interface.py:docstring of orchestrator.Orchestrator.daemon_action:9: WARNING: Field list ends without a blank line; unexpected unindent.

@sebastian-philipp
Copy link
Contributor

needs rebase

@varshar16 varshar16 force-pushed the wip-update-orch-doc-str branch from daffec3 to a397b6e Compare August 7, 2020 05:36
@varshar16 varshar16 changed the title mgr/orchestrator: Update docstring of service_action and daemon_actio… mgr/orchestrator: Update docstring of service_action method Aug 7, 2020
Signed-off-by: Varsha Rao <varao@redhat.com>
@varshar16 varshar16 force-pushed the wip-update-orch-doc-str branch from a397b6e to 4d6365b Compare August 7, 2020 05:58
@sebastian-philipp sebastian-philipp merged commit 296ef28 into ceph:master Aug 7, 2020
@varshar16 varshar16 deleted the wip-update-orch-doc-str branch August 10, 2020 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants