[ 
https://issues.apache.org/jira/browse/SPARK-4992?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Sean Owen updated SPARK-4992:
-----------------------------
    Attachment: SPARK-4992.patch

OK, right I can update the patch to use "foo_bar" style for Python. The patch 
here updates index.html and examples.html.

Anything under {{docs}} is actually something you can propose a PR for via 
GitHub. That's the doc source under {{docs/}}. Happy to propose a change too as 
I'm sure the shadowing is not on purpose there, even if it may not matter.

I think these examples were written and/or updated a long while ago by people 
(perhaps like me) that were mirroring changes to examples in other languages, 
where these are not problems. I don't think it makes sense to judge the PySpark 
code unless, well, you're looking at the PySpark code. (I myself have no idea; 
I don't work in Python or PySpark and didn't write any of this.)

That said, I know the Java examples didn't used to even compile. The problem is 
simply that they are never compiled or run through tests or style checks like 
the rest of the code base proper is. So, for example my first patch wouldn't 
have even passed automated tests as 'real' Python code here.

> Prominent Python example has bad, beginner style
> ------------------------------------------------
>
>                 Key: SPARK-4992
>                 URL: https://issues.apache.org/jira/browse/SPARK-4992
>             Project: Spark
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Eric O. LEBIGOT (EOL)
>            Priority: Trivial
>              Labels: documentation
>         Attachments: SPARK-4992.patch
>
>   Original Estimate: 5m
>  Remaining Estimate: 5m
>
> In the main webpage http://spark.apache.org/, the Python example uses a 
> variable named "file": this is a well-known bad practice (because file is the 
> name of a built-in class).
> Such a prominently visible example should show a better mastery of Python, if 
> Spark is to give confidence in the quality of its Python API.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org

Reply via email to