pandas => Meta: Riktlinjer för dokumentation

Anmärkningar

Detta metapost liknar pythonversionen http://stackoverflow.com/documentation/python/394/meta-documentation-guidelines#t=201607240058406359521 .

Gör redigeringsförslag och kommentera dem (i stället för korrekta kommentarer), så att vi kan utplåna / upprepa dessa förslag :)

Visar kodavsnitt och utdata

Två populära alternativ är att använda:

ipython notation:

In [11]: df = pd.DataFrame([[1, 2], [3, 4]])

In [12]: df
Out[12]:
   0  1
0  1  2
1  3  4

Alternativt (detta är populärt i Python-dokumentationen) och mer kortfattat:

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

I allmänhet är detta bättre för mindre exempel.

Obs: Skillnaden mellan utskrift och utskrift. ipython gör detta tydligt (utskrifterna inträffar innan utgången returneras):

In [21]: [print(col) for col in df]
0
1
Out[21]: [None, None]

stil

Använd pd som pd , detta kan antas (importen behöver inte vara i alla exempel)

import pandas as pd

PEP8!

4 utrymme intryck
kwargs ska inte använda några mellanslag f(a=1)
80 teckengräns (hela linjeanpassningen i det återgivna kodavsnittet bör vara starkt föredraget)

Pandas versionstöd

De flesta exempel fungerar i flera versioner, om du använder en "ny" funktion bör du nämna när den introducerades.

Exempel: sort_values .

tryck uttalanden

För det mesta bör utskrift undvikas eftersom det kan vara en distraktion (Out bör föredras).
Det är:

a
# Out: 1

är alltid bättre än

print(a)
# prints: 1

Föredrar att stödja python 2 och 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)

Modified text is an extract of the original Stack Overflow Documentation

Licensierat under CC BY-SA 3.0

Inte anslutet till Stack Overflow

pandas
Meta: Riktlinjer för dokumentation

Sök…