paramiko / paramiko/paramiko

[BUG] - documentation: copy pasted doc appearing twice in Transport section?

Open
#2,556 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug
Dominant language
Python
Stars
9.9k
Forks
2.1k
PR merge metrics
No merged PRs in 30d

Description

Are you using paramiko as a client or server?

Client

What feature(s) aren't working right?

Something else

What version(s) of paramiko are you using?

stable (according to https://docs.paramiko.org/en/stable/api/transport.html)

What version(s) of Python are you using?

not relevant

What operating system and version are you using?

not relevant

If you're connecting as a client, which SSH server are you connecting to?

not relevant

If you're using paramiko as part of another tool, which tool/version?

not relevant

Expected/desired behavior

Hey guys,

https://docs.paramiko.org/en/stable/api/transport.html

if you search through the documentation , auth_interactive() appears twice and auth_interactive_dumb( ) also appears twice. With different descriptions.

also auth_password(username, password, fallback=True) mentions something about an event? but the method signature does not show any event handler present?

is it someone ctrl+v by error here?

Actual behavior

Non-duplicated documentation section in https://docs.paramiko.org/en/stable/api/transport.html

How to reproduce

Read the doc here https://docs.paramiko.org/en/stable/api/transport.html

on your browser, control+f and search for auth_interactive. 4 instances, 2 duplicated for dumb/not dumb

Anything else?

Merry xmas, thank you for the library, i'll be willing to submit examples how to write a client that auths with 2FA and how to handle all the possible flow during logging, for standard ssh client/sshd configs.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the stable Transport API documentation at https://docs.paramiko.org/en/stable/api/transport.html and search for auth_interactive and auth_interactive_dumb. Compare the duplicated descriptions and the auth_password signature note; done means the duplicate entries are removed or corrected and the rendered documentation matches the API.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.