[
https://issues.apache.org/jira/browse/YARN-6571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16005082#comment-16005082
]
Daniel Templeton commented on YARN-6571:
----------------------------------------
Alrighty then! Let's work on the text. The {{SchedulingPolicy}} is used by the
fair scheduler mainly to determine what a queue's fair share and steady fair
share should be as well as calculating available headroom. Every queue has
one, including parents and children. The policy for a child queue must be
compatible with the policy of the parent queue; there are some combinations
that aren't allowed. See {{isChildPolicyAllowed()}}. The policy for a queue
is specified by setting <whatever the property is> in the fair scheduler
configuration file. If a child queue doesn't specify a policy, it inherits the
parent's policy. The default policy is {{FairSharePolicy}}.
> Fix JavaDoc issues in SchedulingPolicy
> --------------------------------------
>
> Key: YARN-6571
> URL: https://issues.apache.org/jira/browse/YARN-6571
> Project: Hadoop YARN
> Issue Type: Bug
> Components: fairscheduler
> Affects Versions: 2.8.0
> Reporter: Daniel Templeton
> Assignee: Weiwei Yang
> Priority: Trivial
> Labels: newbie
> Attachments: YARN-6571.001.patch, YARN-6571.002.patch
>
>
> There are several javadoc issues:
> * Class JavaDoc is missing.
> * {{getInstance()}} is missing {{@return}} and {{@param}} tags.
> * {{parse()}} is missing {{@return}} tag and description for {{@throws}} tag.
> * {{checkIfUsageOverFairShare()}} is missing a period at the end of the first
> sentence.
> * {{getHeadroom()}} should use {code}{@code}{code} instead of {{<code>}} tags.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
---------------------------------------------------------------------
To unsubscribe, e-mail: yarn-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: yarn-issues-h...@hadoop.apache.org
