statsmodels / statsmodels/statsmodels.github.io
Title line overflows in doc
Nessuno ha ancora preso questa issue.
- Lingua principale
- HTML
- Stelle
- 14
- Fork
- 7
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Describe the bug
While browsing the documentation for statsmodels, certain functions have really long names that overflow. The problem is the text doesn't wrap, causing some of the text to not be selectable or even visible (as showing in the image). Eg: https://www.statsmodels.org/stable/generated/statsmodels.regression.mixed_linear_model.MixedLM.html
Original:
Potential Fix 1:
I believe this could be a simple fix by enabling overflow to scroll. A potential solution could be adding the following to the documentation's CSS:
overflow: scroll;
Potential Fix 2:
I believe this could also be a simple fix by enabling overflow-wrap to anywhere or break-word. A potential solution could be adding the following to the documentation's CSS:
overflow-wrap: anywhere;
Note: As you can see, there are many issues on our GitHub tracker, so it is very possible that your issue has been posted before. Please check first before submitting so that we do not have to handle and close duplicates.
Note: Please be sure you are using the latest released version of statsmodels, or a recent build of main. If your problem has been fixed in an unreleased version, you might be able to use main until a new release occurs.
Note: If you are using a released version, have you verified that the bug exists in the main branch of this repository? It helps the limited resources if we know problems exist in the current main branch so that they do not need to check whether the code sample produces a bug in the next release.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia aprendo la pagina della documentazione di MixedLM collegata e ispeziona il CSS della documentazione che influisce sui titoli o sui link con nomi di funzione lunghi. Riproduci l'overflow in una vista stretta, quindi verifica che i nomi lunghi vadano a capo o possano essere fatti scorrere senza testo nascosto o non selezionabile. Conferma il fix nella pagina interessata e in pagine di documentazione generate simili.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- css, html
- Ambito
- documentation
- Tipo di issue
- Bug
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100