[jira] [Commented] (SPARK-18825) Eliminate duplicate links in SparkR API doc index

["Shivaram Venkataraman (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SPARK-18825?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15742601#comment-15742601 ] 

Shivaram Venkataraman commented on SPARK-18825:
-----------------------------------------------

Yeah this is tricky because of CRAN requirements / S4 method naming schemes. I am not sure there is an easy way out. Longer term we could try to make a better index.html page that modifies the default one generated by roxygen2 -- or open an issue with them ?

> Eliminate duplicate links in SparkR API doc index
> -------------------------------------------------
>
>                 Key: SPARK-18825
>                 URL: https://issues.apache.org/jira/browse/SPARK-18825
>             Project: Spark
>          Issue Type: Documentation
>          Components: Documentation, SparkR
>            Reporter: Joseph K. Bradley
>
> The SparkR API docs contain many duplicate links with suffixes {{-method}} or {{-class}} in the index . E.g., {{atan}} and {{atan-method}} link to the same doc.
> Copying from [~felixcheung] in [SPARK-18332]:
> {quote}
> They are because of the
> {{@ aliases}}
> tags. I think we are adding them because CRAN checks require them to match the specific format - [~shivaram] would you know?
> I am pretty sure they are double-listed because in addition to aliases we also have
> {{@ rdname}}
> which automatically generate the links as well.
> I suspect if we change all the rdname to match the string in aliases then there will be one link. I can take a shot at this to test this out, but changes will be very extensive - is this something we could get into 2.1 still?
> {quote}



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

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