biopython / biopython/biopython.github.io

Brute force Checklist.

Abierto
#38 2 comentarios 0 reacciones 0 asignados Ver en GitHub
help wanted
Lenguaje dominante
CSS
Estrellas
167
Forks
377
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.