[
https://issues.apache.org/jira/browse/YARN-6571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16005042#comment-16005042
]
Daniel Templeton commented on YARN-6571:
----------------------------------------
Thanks for the update, [~cheersyang]. It occurred to me after I posted my
comments that adding the class docs requires a bit more understanding of the
inner working of YARN than is fair for a newbie JIRA. Let's do this. I'll
commit your first patch and then file a new JIRA to add the class javadoc.
With that in mind, +1 to patch 1.
> 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: [email protected]
For additional commands, e-mail: [email protected]
