Skip to content

Commit

Permalink
docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
damoore044 committed Jun 13, 2024
1 parent 7f4bec5 commit 0886bdf
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions robottelo/host_helpers/api_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -485,8 +485,8 @@ def register_host_and_needed_setup(
param force : bool, optional
Force registration of the client to bypass? Default is False.
A reused fixture content host will fail if already registered.
param loc : object, optional
Pass a location object to limit host visibility. Default is None,
param loc : instance, optional
Pass a location to limit host visibility. Default is None,
making the client available to all locations.
Required arguments below, can be any of the following type:
Expand All @@ -505,6 +505,9 @@ def register_host_and_needed_setup(
Pass a Content-View instance, name, or id.
Example: can pass string name 'Default Organization View'.
Note: The Default Organization View cannot be published, promoted, edited etc,
but you can register the client to it.
Steps:
1. Get needed entities from arguments (id, name, or instance). Read all as instance.
2. Publish the content-view if no versions exist or needs_publish.
Expand All @@ -514,8 +517,8 @@ def register_host_and_needed_setup(
6. Register the host using the activation-key associated with the content.
7. Add a rex_key to the client if desired.
Return: dict containing following entries
if succeeeded:
Return: dictionary containing the following entries
if succeeded:
result: success
client: client
organization: entities['Organization']
Expand All @@ -527,7 +530,6 @@ def register_host_and_needed_setup(
result: error
client: None, unless registration was successful
message: Details of the failure encountered
"""

method_error = {
Expand Down

0 comments on commit 0886bdf

Please sign in to comment.