pandas
Meta: Pautas de documentación.
Buscar..
Observaciones
Esta meta publicación es similar a la versión de python http://stackoverflow.com/documentation/python/394/meta-documentation-guidelines#t=201607240058406359521 .
Por favor, haga sugerencias de edición, y comente sobre ellas (en lugar de los comentarios apropiados), para que podamos desarrollarlas / iterarlas sobre estas sugerencias :)
Mostrando fragmentos de código y salida
Dos opciones populares son usar:
notación ipython:
In [11]: df = pd.DataFrame([[1, 2], [3, 4]])
In [12]: df
Out[12]:
0 1
0 1 2
1 3 4
Alternativamente (esto es popular en la documentación de python) y más concisamente:
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
En general, esto es mejor para ejemplos más pequeños.
Nota: La distinción entre salida e impresión. ipython lo aclara (las impresiones se producen antes de que se devuelva la salida):
In [21]: [print(col) for col in df]
0
1
Out[21]: [None, None]
estilo
Utilice la biblioteca de pandas como pd , esto puede ser asumido (la importación no necesita estar en todos los ejemplos)
import pandas as pd
- Sangría de 4 espacios
- los kwargs no deben usar espacios
f(a=1) - Límite de 80 caracteres (la línea completa ajustada en el fragmento de código renderizado debe ser altamente preferida)
Compatibilidad con la versión pandas
La mayoría de los ejemplos funcionarán en varias versiones, si está utilizando una característica "nueva", debe mencionar cuándo se introdujo.
Ejemplo: sort_values .
imprimir declaraciones
La mayoría de las veces se debe evitar la impresión, ya que puede ser una distracción (se debe preferir la salida).
Es decir:
a
# Out: 1
siempre es mejor que
print(a)
# prints: 1
Prefiero el apoyo de python 2 y 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)