Fix broken doc signatures and links #9018
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These anchors were used a long time ago to point to the function after the current function, but their use have become obsolete with the usage of ex_doc.
These anchors were used a long time ago to point to the function after the current function, but their use have become obsolete with the usage of ex_doc.
These anchors were used a long time ago to point to the function after the current function, but their use have become obsolete with the usage of ex_doc.
These anchors were used a long time ago to point to the function after the current function, but their use have become obsolete with the usage of ex_doc.
These anchors were used a long time ago to point to the function after the current function, but their use have become obsolete with the usage of ex_doc.
garazdawi
added
team:VM
CT Test Results 14 files 245 suites 3h 18m 0s ⏱️ Results for commit 031eb6f. ♻️ This comment has been updated with latest results. To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts// Erlang/OTP Github Action Bot |
dgud
approved these changes
Nov 5, 2024
| @@ -1986,7 +1980,7 @@ paged_result_control(PageSize, Cookie) when is_integer(PageSize) -> | |||
| %%% -------------------------------------------------------------------- | |||
|
|
|||
| -doc """ | |||
| paged_result_cookie(SearchResult) -> binary() | |||
| paged_result_cookie(SearchResult) | |||
| @@ -52,7 +52,7 @@ | |||
| %% integer() - explicit detail level of tracing | |||
| %%---------------------------------------------------------------------- | |||
| -doc """ | |||
| make_pattern(RawPattern) -> TracePattern | |||
| make_pattern(RawPattern) | |||
| @@ -115,7 +115,7 @@ make_pattern({Mod, Pattern}) when is_atom(Mod) -> | |||
| %% accordingly with erlang:trace_pattern/2. | |||
| %%---------------------------------------------------------------------- | |||
| -doc """ | |||
| change_pattern(Pattern) -> ok | |||
| change_pattern(Pattern) | |||
| -spec tracer() -> {ok, [node()]} | {error, term()}. | ||
| tracer() -> tracer(node()). | ||
| -doc """ | ||
| tracer(Nodes) -> Result | ||
| tracer(Nodes) |
| @@ -820,7 +794,7 @@ tpl(A,B,C) -> | |||
| dbg:tpl(A,B,ms(C)). | |||
|
|
|||
| -doc """ | |||
| tpl(Module [, Function [, Arity]], MatchSpec) | |||
| tpl(Module, Function, Arity, MatchSpec) | |||
|
@dgud I kept them because otherwise the signature will be incorrect. |
bmk
reviewed
Nov 5, 2024
bmk
approved these changes
Nov 5, 2024
u3s
reviewed
Nov 5, 2024
u3s
reviewed
Nov 6, 2024
| @@ -248,8 +244,6 @@ call(ChannelPid, Msg, TimeOute) -> | |||
| end. | |||
|
|
|||
| -doc """ | |||
| cast(ChannelRef, Msg) -> ok | |||
| Sends an asynchronous message to the channel process and returns ok immediately, | |||
There was a problem hiding this comment.
pls explain. is leaving paragraph containing more than 1 sentence as a signature also fine? In other places I thought single sentence is preferred ...
u3s
reviewed
Nov 6, 2024
| @@ -216,8 +214,6 @@ call(ChannelPid, Msg) -> | |||
| call(ChannelPid, Msg, infinity). | |||
|
|
|||
| -doc """ | |||
| call(ChannelRef, Msg, Timeout) -> Reply | {error, Reason} | |||
There was a problem hiding this comment.
while at it. reply/2 and enter_loop/1 docs look strange in similar aspect. can you adjust them as well?
below funny italic also is rendered as we have text between _ characters.
u3s
approved these changes
Nov 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR removes broken doc signatures that were generated as part of the erl_docgen to ex_doc migration.
It also removes all anchors at the end of a documentation attribute as those links to those anchors almost always pointed to an incorrect place in the docs.