Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] add missing parameters in SparkContext.scala for scala doc #8412

Closed
wants to merge 2 commits into from

Conversation

liyezhang556520
Copy link
Contributor

No description provided.

@srowen
Copy link
Member

srowen commented Aug 25, 2015

I think that's OK, but if you're going to add some params, it would be better to put effort into fully adding missing params for a whole file or package.

@SparkQA
Copy link

SparkQA commented Aug 25, 2015

Test build #41515 timed out for PR 8412 at commit 58e9d2e after a configured wait of 175m.

@liyezhang556520 liyezhang556520 changed the title [DOC] add missing parameters for scala doc [DOC] add missing parameters in SparkContext.scala for scala doc Aug 25, 2015
@liyezhang556520
Copy link
Contributor Author

@srowen , I added the missing params for APIs that intending to adding params in the whole file. I'm wondering whether those missing @param are on purpose or not. Since in current spark code, there are many places missing @param and @return, if we want to make the doc better, I think someone need to open a JIRA to solve it.
And I submit this PR because SparkContext.scala is a very import file in spark core, and It's constructor APIs should be with complete scala docs.

@srowen
Copy link
Member

srowen commented Aug 25, 2015

No problem, I'll merge it. I don't think these were omitted on purpose. You might look over this one file and see if anything else needs a touch up.

@SparkQA
Copy link

SparkQA commented Aug 25, 2015

Test build #1689 has finished for PR 8412 at commit 58e9d2e.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

asfgit pushed a commit that referenced this pull request Aug 25, 2015
Author: Zhang, Liye <liye.zhang@intel.com>

Closes #8412 from liyezhang556520/minorDoc.

(cherry picked from commit 5c14890)
Signed-off-by: Sean Owen <sowen@cloudera.com>
@asfgit asfgit closed this in 5c14890 Aug 25, 2015
@SparkQA
Copy link

SparkQA commented Aug 25, 2015

Test build #41530 timed out for PR 8412 at commit 8b41ddf after a configured wait of 175m.

@liyezhang556520 liyezhang556520 deleted the minorDoc branch August 26, 2015 01:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants