ssh: polish docs around types #9298
Conversation
CT Test Results 2 files 29 suites 20m 2s ⏱️ Results for commit c750b7e. ♻️ 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 |
lib/ssh/src/ssh.erl
Outdated
| @@ -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!?
There was a problem hiding this comment.
I don't have an idea now. But I removed the title so we just have a generic Types category with them ... maybe it is good enough as they are sort of general types.
| @@ -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!
There was a problem hiding this comment.
you mean opaque_ part in type names below?
- move from conn_info_channels to connection_info_tuple - fix typo
No description provided.