biopython / biopython/biopython.github.io

Brute force Checklist.

未關閉
#38 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
help wanted
主要語言
CSS
星號
167
分支
377
PR 合併指標
30 天內沒有已合併 PR

描述

As suggested by Markus Piotrowski
Checklist:
1. Title
- The title in the markdown file may be changed into something more user-friendly (https://github.com/biopython/biopython.github.io/issues/22)
- Take care that the title is not repeated in the main text (like here: http://biopython.org/wiki/Documentation)
1. Is the text up-to-date? (Python versions etc)
2. Formatting
3. Suggestion: Python/Biopython commands, keywords, module/function names should be formatted as inline-code with single backticks, e.g. `Bio.SeqIO` ??? Or bold???
4. If applicable, they can also serve as links to the respective Wiki page
5. Code output and command-line examples should be formatted as block code with three backticks instead of several single line inline-code statements.
6. Check block code for trailing white spaces, which may result in the addition of an (unnecessary) horizontal scrollbars as here: http://biopython.org/wiki/ACE_contig_to_alignment.
7. Code
8. Code should be checked for a minimum of PEP8 compliance.
9. The code should work (as it is) under Biopython 1.66
10. Since we are recommending Python 3.5 as environment, the code should work under Python 3.5 ???
11. Links
12. Check all links
13. 'Repair' broken links
Try to find a link that's more likely to be stable. E.g. for papers I think that dx.doi.org references (or Pubmed references) are more stable than linking to a special page of the respective journal or private or institutional homepages. With http://www.crossref.org/SimpleTextQuery/ you can do a reverse doi lookup for a given paper.
14. Links with anchors (.../some_page#jump_here) may have issues with upper/lowercase formatting (https://github.com/biopython/biopython.github.io/issues/13)
15. Are the links up-to-date? E.g. in http://biopython.org/wiki/Getting_Started the Python Quick Reference links to Python 2.5
16. References
17. Some pages used a PubMed plugin under MediaWiki to display references (https://github.com/biopython/biopython.github.io/issues/12). Since it's unlikely (?) to have a functional replacement, I would suggest to convert them to simple links.
18. RSS feeds
19. As above, embedding an existing RSS feed seems hard (https://github.com/biopython/biopython.github.io/issues/4), again I would suggest replace with a link pointing to the RSS feed

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

首先查看 Documentation、ACE_contig_to_alignment 和 Getting_Started 背後的 Markdown 頁面,然後根據此檢查清單比較它們的格式、Python/Biopython 範例、連結、參考資料和 RSS 區段。以下情況表示完成:適用頁面是最新的,連結和錨點可以正常運作,範例符合所述的 Python 和 Biopython 版本,且嵌入的參考資料或 feed 已依建議替換。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
markdown, python
領域
content, documentation
Issue 類型
文件
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
需要釐清
新手友好度
20/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。