spark-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From actuaryzhang <...@git.apache.org>
Subject [GitHub] spark issue #18366: [SPARK-20889][SparkR] Grouped documentation for STRING c...
Date Mon, 26 Jun 2017 06:29:52 GMT
Github user actuaryzhang commented on the issue:

    https://github.com/apache/spark/pull/18366
  
    @felixcheung Since there are only two methods with argument signature `(y, x)`,  I think
it's best to document them together with the other string methods. Also, not aiming to rename
the parameters since there are lots of other methods defined this way. In the current PR,
I think we just need to be very clear in the documentation. I made a commit with the following
changes. 
    - In documenting `x`, I call out that it has different meaning in `instr` and `format_number`.

    - In the details part of  `instr` and `format_number`, I make explicit reference to `x`
and `y` and explain their meanings. 
    I think the improved doc together with the examples offer enough clarify now. 
    ![image](https://user-images.githubusercontent.com/11082368/27526930-e476feec-59fd-11e7-9734-051b2e6860da.png)
    ![image](https://user-images.githubusercontent.com/11082368/27526970-1860fa5a-59fe-11e7-976f-321cf0caa172.png)
    ![image](https://user-images.githubusercontent.com/11082368/27526973-1b27ed48-59fe-11e7-939e-53f1c9f08ddc.png)
    



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

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


Mime
View raw message