Title line overflows in doc
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 45/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- css, html
调研方向
首先打开链接的 MixedLM 文档页面,检查影响长函数名标题或链接的文档 CSS。在窄视图中重现溢出,然后确认长名称会换行或可以滚动查看,且不会有文本被隐藏或无法选中。在受影响的页面以及类似的生成文档页面上确认修复。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- HTML
- 星标
- 14
- 派生
- 7
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
statsmodels/statsmodels.github.io 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 45/100
statsmodels/statsmodels.github.io#28 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 30/100
statsmodels/statsmodels.github.io#26 · 3 条评论 ·
查看 statsmodels/statsmodels.github.io 的全部 Issue
相似的 Issue
-
documentation
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 88/100
-
sync-en
难度 1/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
sync-en
难度 1/5 1 小时以内 新手友好度 82/100
维护者通常 3 天内回复
-
难度 1/5 1 小时以内 新手友好度 92/100
QuantEcon/lecture-python-programming#642 ·
维护者通常 1 天内回复