Kuba/ssh/doc fixes 09 05

[u3s]

No description provided.

[github-actions]

CT Test Results

    2 files     29 suites   19m 7s ⏱️
  481 tests   475 ✅  6 💤 0 ❌
1 686 runs  1 660 ✅ 26 💤 0 ❌

Results for commit 1eba2fc.

♻️ 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

• Complete CT logs (Download Logs)
• HTML Documentation (Download HTML Docs)
• No Windows Installer found

// Erlang/OTP Github Action Bot

[IngelaAndin]

Why does ssh_file document its callbacks at all, the ones that are documented in ssh_key_api and ssh_client_api. My understanding is that users are no meant to call them directly, so they should not be documented here?!

[IngelaAndin]

See general comment in PR

[u3s]

Why does ssh_file document its callbacks at all, the ones that are documented in ssh_key_api and ssh_client_api. My understanding is that users are no meant to call them directly, so they should not be documented here?!

• ssh_file seems to provide some more details on top of callbacks from ssh_client_key_api and ssh_server_key_api
• also ssh_file implements only selected ssh_client_key_api callbacks - so in that sense I can understand why ssh_file documents callbacks

[IngelaAndin]

The pages ssh_file page it self states: "The functions are Callbacks for the SSH app. They are not intended to be called from the user's code!"

So this is not an API and should not be documented as such.

ssh-file does not implement deprecated callbacks (they might be deprecated only in the documentation). And I think an extra signing function that purpose is there for "engine type" customization.

So this should not be documented in this way, it is confusing. I think some of the information might qualify for SSH users guide
documentation and the rest is internal documentation.

[IngelaAndin]

If there is something that you think is relevant to the implementers of callback then that information could also be put in the callback API decriptions.