ssh: polish docs around types #9298
Open
+50
−49
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
CT Test Results 2 files 29 suites 18m 1s ⏱️ Results for commit 2fcaee9. ♻️ 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 |
kikofernandez
previously approved these changes
Jan 14, 2025
IngelaAndin
reviewed
Jan 15, 2025
| @@ -225,7 +229,7 @@ Opaque data type representing a connection between a client and a server | |||
| Returned by the functions [`connect/2,3,4`](`connect/3`) and | |||
| [`ssh_sftp:start_channel/2,3`](`ssh_sftp:start_channel/2`). | |||
| """. | |||
| -doc(#{title => <<"Other data types">>}). | |||
| -doc(#{title => <<"Other Data Types">>}). | |||
There was a problem hiding this comment.
Could we perhaps find better categories than "Other" ?
Maybe not all now other belong in the same category!?
IngelaAndin
reviewed
Jan 15, 2025
| @@ -514,7 +515,7 @@ protocol). | |||
| Opaque types that define experimental options that are not to be used in | |||
| products. | |||
| """. | |||
| -doc(#{title => <<"Other data types">>}). | |||
| -doc(#{title => <<"Other Data Types">>}). | |||
There was a problem hiding this comment.
What is meant with opaque option? This does not make sense to me!
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.
No description provided.