Conversation
The inet:getaddr/3 function is exported but marked -doc false, hiding itfrom the documentation.
Move the full documentation to the /3 variant and use the
#{equiv => ...} attribute on the /2 version.
|
|
CT Test Results 2 files 74 suites 1h 12m 54s ⏱️ For more details on these failures, see this check. Results for commit 5859856. ♻️ 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 |
There was a problem hiding this comment.
Pull request overview
Documents the previously hidden exported inet:getaddr/3 API and makes inet:getaddr/2 reference it as the equivalent default-timeout variant.
Changes:
- Move the full
-doctext fromgetaddr/2togetaddr/3(removing-doc falsefrom/3). - Add
-doc(#{equiv => getaddr(Host, Family, infinity)}).togetaddr/2to link it to the/3variant. - Extend the documentation to describe the
Timeoutparameter and its default.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Clarified the description of the Timeout parameter in the getaddr function.
The inet:getaddr/3 function is exported but marked -doc false, hiding it from the documentation.
Move the full documentation to the /3 variant and use the #{equiv => ...} attribute on the /2 version.