biopython / biopython/biopython.github.io

Brute force Checklist.

Ouverte
#38 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
help wanted
Langage dominant
CSS
Étoiles
167
Forks
377
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par examiner les pages Markdown derrière Documentation, ACE_contig_to_alignment et Getting_Started, puis comparez leur mise en forme, leurs exemples Python/Biopython, leurs liens, leurs références et leurs sections RSS avec cette liste de contrôle. Le travail est considéré comme terminé lorsque les pages concernées sont à jour, que les liens et les ancres fonctionnent, que les exemples respectent les versions indiquées de Python et de Biopython, et que les références ou flux intégrés sont remplacés comme suggéré.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
markdown, python
Domaine
content, documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
20/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.