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

Go documentation is missing reference links

Aperta
#2,157 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
40/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
go
Ambito
documentation

Direzione di ricerca

Confronta la pagina di devdocs.io relativa a net/http Client.Do con il riferimento collegato su pkg.go.dev per identificare i link mancanti al codice sorgente e agli input/output. Individua quindi il punto di ingresso della generazione della documentazione Go e i relativi test; il lavoro è completo quando le intestazioni di riferimento Go generate espongono in modo coerente i link previsti.

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

Descrizione

docs/improvement

Documentation style bug: Go documentation missing reference links

Summary

devdocs.io is missing useful links in Go reference documentation that are very handy when working with package API:

  • links to the Go source code implementation for the code
  • links to input/output structures

I'm happy to contribute a fix if this is a bug rather than a deliberate choice.

Actual style

See https://devdocs.io/go/net/http/index#Client.Do and how the header does not have links:

Screenshot 2024-02-18 at 21 03 19

Expected style

Official documentation that has links in the header: https://pkg.go.dev/net/http#Client.Do
Screenshot 2024-02-18 at 21 03 28

Lingua principale
Ruby
Stelle
39.5k
Fork
2.6k
Merge medio
2g 9h
PR unite (30g)
13

Guida per i contributori

Apri la guida per i contributori

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 freeCodeCamp/devdocs

Tutte le issue di freeCodeCamp/devdocs

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.