spark-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Mihály Tóth <misut...@gmail.com>
Subject Re: Help needed in R documentation generation
Date Tue, 27 Feb 2018 17:13:18 GMT
Hi,

Earlier, at https://spark.apache.org/docs/latest/api/R/index.html I see

   1. sin as a title
   2. description describes what sin does
   3. usage, arguments, note, see also are specific to sin function

When opening sin from
https://dist.apache.org/repos/dist/dev/spark/v2.3.0-rc5-docs/_site/api/R/index.html
:

   1. Title is 'Math functions for Column operations', not very specific to
   sin
   2. Description is 'Math functions defined for Column.'
   3. Usage contains a list of functions, scrolling down you can see sin as
   well though ...

To me that sounds like a problem. Do I overlook something here?

Best Regards,
  Misi


2018-02-27 16:15 GMT+00:00 Felix Cheung <felixcheung_m@hotmail.com>:

> The help content on sin is in
> https://dist.apache.org/repos/dist/dev/spark/v2.3.0-rc5-
> docs/_site/api/R/column_math_functions.html
>
> It’s a fairly long list but sin is in there. Is that not what you are
> seeing?
>
>
> ------------------------------
> *From:* Mihály Tóth <mtoth@cloudera.com>
> *Sent:* Tuesday, February 27, 2018 8:03:34 AM
> *To:* dev@spark.apache.org
> *Subject:* Fwd: Help needed in R documentation generation
>
> Hi,
>
> Actually, when I open the link you provided and click on - for example -
> 'sin' the page does not seem to describe that function at all. Actually I
> get same effect that I get locally. I have attached a screenshot about that:
>
>
> [image: Szövegközi kép 1]
>
>
> I tried with Chrome and then with Safari too and got the same result.
>
> When I go to https://spark.apache.org/docs/latest/api/R/index.html (Spark
> 2.2.1) and select 'sin' I get a proper Description, Usage, Arguments, etc.
> sections.
>
> This sounds like a bug in the documentation of Spark R, does'nt it? Shall
> I file a Jira about it?
>
> Locally I ran SPARK_HOME/R/create-docs.sh and it returned successfully.
> Unfortunately with the result mentioned above.
>
> Best Regards,
>
>   Misi
>
>
>
>> --------------------
>>
>> From: Felix Cheung <felixcheung_m@hotmail.com>
>> Date: 2018-02-26 20:42 GMT+00:00
>> Subject: Re: Help needed in R documentation generation
>> To: Mihály Tóth <misutoth@gmail.com>
>> Cc: "dev@spark.apache.org" <dev@spark.apache.org>
>>
>>
>> Could you tell me more about the steps you are taking? Which page you are
>> clicking on?
>>
>> Could you try https://dist.apache.org/repos/
>> dist/dev/spark/v2.3.0-rc5-docs/_site/api/R/index.html
>>
>> ------------------------------
>> *From:* Mihály Tóth <misutoth@gmail.com>
>> *Sent:* Monday, February 26, 2018 8:06:59 AM
>> *To:* Felix Cheung
>> *Cc:* dev@spark.apache.org
>> *Subject:* Re: Help needed in R documentation generation
>>
>> I see.
>>
>> When I click on such a selected function, like 'sin' the page falls apart
>> and does not tell anything about sin function. How is it supposed to work
>> when all functions link to the same column_math_functions.html ?
>>
>> Thanks,
>>
>>   Misi
>>
>>
>> On Sun, Feb 25, 2018, 22:53 Felix Cheung <felixcheung_m@hotmail.com>
>> wrote:
>>
>>> This is recent change. The html file column_math_functions.html should
>>> have the right help content.
>>>
>>> What is the problem you are experiencing?
>>>
>>> ------------------------------
>>> *From:* Mihály Tóth <misutoth@gmail.com>
>>> *Sent:* Sunday, February 25, 2018 10:42:50 PM
>>> *To:* dev@spark.apache.org
>>> *Subject:* Help needed in R documentation generation
>>>
>>> Hi,
>>>
>>> I am having difficulties generating R documentation.
>>>
>>> In R/pkg/html/index.html file at the individual function entries it
>>> reference
>>> column_math_functions.html instead of the function page itself. Like
>>>
>>> <a href="column_math_functions.html">asin</a>
>>>
>>> Have you met with such a problem?
>>>
>>> Thanks,
>>>
>>>   Misi
>>>
>>>
>>>
>>
>
>

Mime
View raw message