Skip to content

Commit

Permalink
Minor docs corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
dimon222 authored and kevin-bates committed Nov 5, 2019
1 parent 73d302a commit d2afa0d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
4 changes: 4 additions & 0 deletions yarn_api_client/history_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@ def job_attempts(self, job_id):
"""
With the job attempts API, you can obtain a collection of resources
that represent a job attempt.
:param str job_id: The job id
:returns: API response object with JSON data
:rtype: :py:class:`yarn_api_client.base.Response`
"""
path = '/ws/v1/history/mapreduce/jobs/{jobid}/jobattempts'.format(
jobid=job_id)
Expand Down
9 changes: 6 additions & 3 deletions yarn_api_client/resource_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,8 @@ def cluster_scheduler_queue(self, yarn_queue_name):
tries to locate the queue using breadth-first-search algorithm.
:param str yarn_queue_name: case sensitive queue name
:return: queue Dictionary, None if not found
:return: queue, None if not found
:rtype: dict
"""
scheduler = self.cluster_scheduler().data
scheduler_info = scheduler['scheduler']['schedulerInfo']
Expand Down Expand Up @@ -555,10 +556,12 @@ def cluster_queue_partition(self, candidate_queue, cluster_node_label):
"""
A queue can be divided into multiple partitions having different node labels.
Given the candidate queue and parition node label, this extracts the partition
we are interested in
we are interested in.
:param dict candidate_queue: queue dictionary
:param str cluster_node_label: case sensitive node label name
:return: partition Dict, None if not Found.
:return: partition, None if not Found.
:rtype: dict
"""
for partition in candidate_queue['capacities']['queueCapacitiesByPartition']:
if partition['partitionName'] == cluster_node_label:
Expand Down

0 comments on commit d2afa0d

Please sign in to comment.