ssh: polish docs #9298
ssh: polish docs #9298
Conversation
CT Test Results 2 files 29 suites 19m 45s ⏱️ Results for commit e25585a. ♻️ 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 |
| @@ -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?
There was a problem hiding this comment.
Yes! I do not think options can be opaque. You need to know what it is you are setting to be able to set it. Opaque I think is used to say that the user should not care how something "looks" (is represented) it is only an abstract handle that can be used as input to the API functions of the module. A truly opaque value can only be inspected by the module implementing it. And that is why we have some values that are only documented opaque as we want users to be able to match them for equality although we do think it is an API violation to pick them apart and do things with an individual part.
There was a problem hiding this comment.
And that is why we have some values that are only documented opaque as we want users to be able to match them for equality although we do think it is an API violation to pick them apart and do things with an individual part.
Testing (in-)equality of opaques with the same name is okay in master, as it does not leak any information about the contents. You can start looking into making these types actually opaque now :-)
- move from conn_info_channels to connection_info_tuple - fix typo
u3s
force-pushed
the
kuba/ssh/polish_docs
branch
from
d84400e to
e25585a
Compare
No description provided.