pandas
Meta: Guide de documentation
Recherche…
Remarques
Cette méta-post est similaire à la version de python http://stackoverflow.com/documentation/python/394/meta-documentation-guidelines#t=201607240058406359521 .
S'il vous plaît faire des suggestions d'édition et commenter celles-ci (au lieu de commentaires appropriés), afin que nous puissions étoffer / itérer sur ces suggestions :)
Affichage des extraits de code et sortie
Deux options populaires sont à utiliser:
notation ipython:
In [11]: df = pd.DataFrame([[1, 2], [3, 4]])
In [12]: df
Out[12]:
0 1
0 1 2
1 3 4
Alternativement (c'est populaire dans la documentation de python) et de manière plus concise:
df.columns # Out: RangeIndex(start=0, stop=2, step=1)
df[0]
# Out:
# 0 1
# 1 3
# Name: 0, dtype: int64
for col in df:
print(col)
# prints:
# 0
# 1
Généralement, cela vaut mieux pour les plus petits exemples.
Remarque: la distinction entre sortie et impression. ipython le dit clairement (les impressions se produisent avant que la sortie ne soit renvoyée):
In [21]: [print(col) for col in df]
0
1
Out[21]: [None, None]
style
Utilisez la bibliothèque de pandas en tant que pd , cela peut être supposé (l'importation n'a pas besoin d'être dans chaque exemple)
import pandas as pd
- 4 indentation spatiale
- kwargs ne doit utiliser aucun espace
f(a=1) - Limite de 80 caractères (toute la ligne correspondant à l'extrait de code rendu doit être fortement préférée)
Prise en charge de la version Pandas
La plupart des exemples fonctionneront sur plusieurs versions, si vous utilisez une "nouvelle" fonctionnalité, vous devez indiquer quand elle a été introduite.
Exemple: sort_values .
imprimer des relevés
La plupart du temps, l’impression doit être évitée car cela peut être une distraction (la préférence doit être donnée à la sortie).
C'est:
a
# Out: 1
est toujours mieux que
print(a)
# prints: 1
Préférez le support de python 2 et 3:
print(x) # yes! (works same in python 2 and 3)
print x # no! (python 2 only)
print(x, y) # no! (works differently in python 2 and 3)