[
https://issues.apache.org/jira/browse/MXNET-1432?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Iblis Lin updated MXNET-1432:
-----------------------------
Description:
The {{@autodoc}} macro will output all the stuffs from the module.
Considering build a filter for hiding all private functions that the name
starts with `_`.
Ref:
[https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@autodocs-block-1]
{code:java}
Filter = x -> match(r"(\.@?_|^_)", string(x)) ≡ nothing
{code}
Consider the filter out {{@_}} as well.
was:
The {{@autodoc}} macro will output all the stuffs from the module.
Considering build a filter for hiding all private functions that the name
starts with `_`.
Ref:
[https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@autodocs-block-1]
{code:java}
Filter = x -> !startswith(string(x), "MXNet.mx._")
{code}
Consider the filter out {{@_}} as well.
> Hide private function in API Reference of Julia doc
> ---------------------------------------------------
>
> Key: MXNET-1432
> URL: https://issues.apache.org/jira/browse/MXNET-1432
> Project: Apache MXNet
> Issue Type: Story
> Components: Apache MXNet Julia API
> Reporter: Iblis Lin
> Assignee: Iblis Lin
> Priority: Major
>
> The {{@autodoc}} macro will output all the stuffs from the module.
> Considering build a filter for hiding all private functions that the name
> starts with `_`.
> Ref:
> [https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@autodocs-block-1]
> {code:java}
> Filter = x -> match(r"(\.@?_|^_)", string(x)) ≡ nothing
> {code}
>
> Consider the filter out {{@_}} as well.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
