You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by MichaelChirico <gi...@git.apache.org> on 2018/08/30 04:06:57 UTC

[GitHub] spark pull request #22278: emphasize deprecation

GitHub user MichaelChirico opened a pull request:

    https://github.com/apache/spark/pull/22278

    emphasize deprecation

    Was poking around documentation for `formals` of this method as I'd seen it recommended and completely missed the `Deprecated` tag; even after seeing elsewhere it's deprecated, I stared at the documentation for far too long before noticing the existing tag.
    
    So, adding this to emphasize further
    
    ## What changes were proposed in this pull request?
    
    (Please fill in changes proposed in this fix)
    
    ## How was this patch tested?
    
    (Please explain how this patch was tested. E.g. unit tests, integration tests, manual tests)
    (If this patch involves UI changes, please attach a screenshot; otherwise, remove this)
    
    Please review http://spark.apache.org/contributing.html before opening a pull request.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/MichaelChirico/spark patch-1

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/spark/pull/22278.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #22278
    
----
commit b196cbdd7e9a3a54354ad341781552b66f6d6b11
Author: Michael Chirico <mi...@...>
Date:   2018-08-30T04:06:50Z

    emphasize deprecation
    
    Was poking around documentation for `formals` of this method as I'd seen it recommended and completely missed the `Deprecated` tag; even after seeing elsewhere it's deprecated, I stared at the documentation for far too long before noticing the existing tag.
    
    So, adding this to emphasize further

----


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] spark issue #22278: emphasize deprecation [documentation tweak]

Posted by MichaelChirico <gi...@git.apache.org>.
Github user MichaelChirico commented on the issue:

    https://github.com/apache/spark/pull/22278
  
    @HyukjinKwon this is about usability/user-friendliness. As mentioned, despite being a seasoned R user & increasingly familiar with `SparkR` documentation, I spent several minutes googling about before realizing the existing "marking".
    
    Happy to try and help file this patch somewhere else if you see fit; just filed here because it's a very easy fix & could be done in-browser without cloning locally/etc


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] spark pull request #22278: emphasize deprecation [documentation tweak]

Posted by MichaelChirico <gi...@git.apache.org>.
Github user MichaelChirico closed the pull request at:

    https://github.com/apache/spark/pull/22278


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] spark issue #22278: emphasize deprecation [documentation tweak]

Posted by HyukjinKwon <gi...@git.apache.org>.
Github user HyukjinKwon commented on the issue:

    https://github.com/apache/spark/pull/22278
  
    If this is the only one, we could try to think differently but I guess there are multiple APIs documented like this. They are all consistently marked in the documentation and in the cod in this way. Unless there's a strong reason to change this kind of convention, I wouldn't fix those.


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] spark issue #22278: emphasize deprecation [documentation tweak]

Posted by HyukjinKwon <gi...@git.apache.org>.
Github user HyukjinKwon commented on the issue:

    https://github.com/apache/spark/pull/22278
  
    I think there are many same instances. We should fix them everywhere consistently. But I don't think it's worth enough fixing everywhere. It's marked as deprecated and so it's deprecated, isn't it?


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] spark issue #22278: emphasize deprecation [documentation tweak]

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/22278
  
    Can one of the admins verify this patch?


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] spark issue #22278: emphasize deprecation [documentation tweak]

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/22278
  
    Can one of the admins verify this patch?


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] spark issue #22278: emphasize deprecation [documentation tweak]

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/22278
  
    Can one of the admins verify this patch?


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org