[jira] [Resolved] (SPARK-23248) Relocate module docstrings to the top in PySpark examples

["Hyukjin Kwon (JIRA)" <ji...@apache.org>]

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

Hyukjin Kwon resolved SPARK-23248.
----------------------------------
       Resolution: Fixed
    Fix Version/s: 2.3.0

Issue resolved by pull request 20416
[https://github.com/apache/spark/pull/20416]

> Relocate module docstrings to the top in PySpark examples
> ---------------------------------------------------------
>
>                 Key: SPARK-23248
>                 URL: https://issues.apache.org/jira/browse/SPARK-23248
>             Project: Spark
>          Issue Type: Improvement
>          Components: Examples, PySpark
>    Affects Versions: 2.3.0
>            Reporter: Hyukjin Kwon
>            Assignee: Hyukjin Kwon
>            Priority: Minor
>             Fix For: 2.3.0
>
>
> docstrings for some examples looks placed wrongly (under imports). For example, if i run
> {code}
> >>> help(aft_survival_regression)
> {code}
> It shows as below:
> {code}
> Help on module aft_survival_regression:
> NAME
>     aft_survival_regression
> ...
> DESCRIPTION
>     # Licensed to the Apache Software Foundation (ASF) under one or more
>     # contributor license agreements.  See the NOTICE file distributed with
>     # this work for additional information regarding copyright ownership.
>     # The ASF licenses this file to You under the Apache License, Version 2.0
>     # (the "License"); you may not use this file except in compliance with
>     # the License.  You may obtain a copy of the License at
>     #
>     #    http://www.apache.org/licenses/LICENSE-2.0
>     #
>     # Unless required by applicable law or agreed to in writing, software
>     # distributed under the License is distributed on an "AS IS" BASIS,
>     # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
>     # See the License for the specific language governing permissions and
>     # limitations under the License.
>     #
> ...
> (END)
> {code}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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