Go documentation is missing reference links
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 40/100
- Type d'issue
- Bug
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- go
- Domaine
- documentation
Piste de recherche
Comparez la page devdocs.io de net/http Client.Do avec la référence liée sur pkg.go.dev afin d’identifier les liens manquants vers le code source et les entrées/sorties. Localisez ensuite le point d’entrée de la génération de la documentation Go et les tests associés ; le travail est terminé lorsque les en-têtes de référence Go générés exposent systématiquement les liens attendus.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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:
Expected style
Official documentation that has links in the header: https://pkg.go.dev/net/http#Client.Do
- Langage dominant
- Ruby
- Étoiles
- 39.5k
- Forks
- 2.6k
- Merge moyen
- 2 j 9 h
- PR mergées (30 j)
- 13
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de freeCodeCamp/devdocs
-
class Data in Ruby 3.2 Ouvertedocs/improvement
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
freeCodeCamp/devdocs#1989 · 4 commentaires · 4 réactions ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 30/100
freeCodeCamp/devdocs#2683 · 1 commentaire ·
-
Unit test frontend code Ouvertefeature
Difficulté 4/5 3-5 jours Accessibilité débutants 45/100
freeCodeCamp/devdocs#2673 ·
Toutes les issues de freeCodeCamp/devdocs
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
-
bug
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
riscv/riscv-unified-db#2626 ·
-
Component: GLib
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
-
ds-drift
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
we-promise/sure#3693 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
simp/pupmod-simp-simp#395 ·