freeCodeCamp / freeCodeCamp/devdocs

Go documentation is missing reference links

Ouverte
#2,157 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
docs/improvement
Langage dominant
Ruby
Étoiles
39.5k
Forks
2.6k
Merge moyen
4 j 32 min
PR mergées (30 j)
13

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Compare the devdocs.io net/http Client.Do page with the linked pkg.go.dev reference to identify the missing source and input/output links. Then locate the Go documentation generation entry point and its related tests; done means generated Go reference headers expose the expected links consistently.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
go
Domaine
documentation
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
40/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.