Skip to content

Hide report_cb/1 from docs#88

Closed
wojtekmach wants to merge 1 commit intobeam-telemetry:mainfrom
wojtekmach:wm-hide-report-cb
Closed

Hide report_cb/1 from docs#88
wojtekmach wants to merge 1 commit intobeam-telemetry:mainfrom
wojtekmach:wm-hide-report-cb

Conversation

@wojtekmach
Copy link
Contributor

for posterity, with this code:

-module(foo).
-export([f1/0]).

%% @hidden
f1() -> ok.

we end up with the following chunk:

{docs_v1,[{file,"foo.erl"},{location,1}],
         erlang,<<"application/erlang+html">>,none,#{},
         [{{function,f1,0},
           [{file,"foo.erl"},{location,5}],
           [<<"f1()">>],
           none,#{}}]}

note the function gets the doc none.

when we switch @hidden to @private:

{docs_v1,[{file,"foo.erl"},{location,1}],
         erlang,<<"application/erlang+html">>,none,#{},
         [{{function,f1,0},
           [{file,"foo.erl"},{location,5}],
           [<<"f1()">>],
           hidden,#{}}]}

we get what we want, hidden.

@wojtekmach
Copy link
Contributor Author

we're gonna tackle this on ExDoc side.

@wojtekmach wojtekmach closed this Jul 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant