[
https://issues.apache.org/jira/browse/SPARK-18825?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16017817#comment-16017817
]
Maciej Szymkiewicz edited comment on SPARK-18825 at 5/19/17 6:42 PM:
---------------------------------------------------------------------
Originally I thought about patching it for our own usage, but I can open an
issue / PR and see what they have to say. Problematic html is not even
generated by {{knitr}} so technically speaking we can just {{sed}} this thing
between:
{code}
. "$FWDIR/install-dev.sh"
{code}
and calling {{knitr}}
Regarding {{dontrun}} - right now we have a lot of examples which are never
executed to satisfy CRAN requirements but could be run locally when we
{{create_docs}}. Running these could:
- Serve as additional tests.
- Reduce maintenance burden.
- Improve quality of the docs (strip {{## Not run:}} and {{##D}} and provide
actual output).
was (Author: zero323):
Originally I thought about patching it for our own usage, but I can open an
issue / PR and see what they have to say. Problematic html is not even
generated by {{knitr}} so technically speaking we can just {{sed}} this thing
between:
{code}
. "$FWDIR/install-dev.sh"
{code}
and calling {{knitr}}
Regarding {{dontrun}} - right now we have a lot of examples which are never
executed to satisfy CRAN requirements. Calling these could:
- Serve as additional tests.
- Reduce maintenance burden.
- Improve quality of the docs (strip {{## Not run:}} and {{##D}} and provide
actual output).
> 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.15#6346)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
