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

Possibly incorrect link to main page from "Templates generator"?

Aperta
#9 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
35/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia da docs/source/utilities/yaml_generator.rst e ispeziona il riferimento :backends_content:, quindi confronta la sua posizione in docs/source/index.rst con docs/source/utilities/templates.rst. Verifica che il riferimento punti ai template YAML anziché alla pagina principale; il lavoro è completato quando il link renderizzato del generatore Templates apre la documentazione dei template prevista.

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

Descrizione

documentation question

The use of the reference :backends_content in this line: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/source/utilities/yaml_generator.rst?plain=1#L5

appears to be wanting to link to the YAML templates that have been generated.

However, while the text of the link is what is expected for a link to YAML templates:
templates-generator-link

it actually links to the main page, which doesn't seem like what would be intended?

The linking to the main page is likely due to the reference being put in index.rst: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/source/index.rst?plain=1#L3-L9

and should instead be moved to somewhere in the templates.rst file.

Lingua principale
Python
Stelle
0
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

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 DiamondLightSource/httomo-backends

Tutte le issue di DiamondLightSource/httomo-backends

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.