Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Consider linking to documentation of underlying libssh2 functions

Aperta
  • Qualcosa non va?
#282 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
rust
Ambito
documentation

Direzione di ricerca

Inizia dai commenti dell’API di check e check_port mostrati nell’issue e confrontali con la documentazione collegata di libssh2_knownhost_checkp. Individua i commenti di documentazione Rust pertinenti e aggiungi collegamenti alla documentazione libssh2 sottostante nei punti in cui chiariscono il comportamento; il lavoro è completato quando gli utenti possono seguire i collegamenti senza duplicare il testo upstream.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Comments are sometimes not really helpful and require digging in the underlying C-sources or at least libssh2's documentation.

Example:

    // Checks a host and its associated key against the collection of known
    /// hosts, and returns info back about the (partially) matched entry.
    ///
    /// The host name can be the IP numerical address of the host or the full
    /// name. The key must be the raw data of the key.
    pub fn check(&self, host: &str, key: &[u8]) -> CheckResult {
        self.check_port_(host, -1, key)
    }
    /// Same as `check`, but takes a port as well.
    pub fn check_port(&self, host: &str, port: u16, key: &[u8]) -> CheckResult {
        self.check_port_(host, port as i32, key)
    }

So, Same as "check", but takes a port as well. isn't super helpful to the reader.

The underlying libssh2 documentation is very specific:

port is the port number used by the host (or a negative number to check the generic host). If the port number is given, libssh2 will check the key for the specific host + port number combination in addition to the plain host name only check.
(emphasis added).

So I wonder if just adding hyperlinks to libssh2's documentation would be helpful to users of the crate (vs. duplicating and synching upstream documentation) to clarify the details of the underlying implementation.

Lingua principale
Rust
Stelle
571
Fork
166
Merge medio
1g 18h
PR unite (30g)
5

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di rust-lang/ssh2-rs

Tutte le issue di rust-lang/ssh2-rs

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.