PieterTack / polycap

Polycapillary X-ray raytracing
GNU General Public License v3.0
3 stars 3 forks source link

Python documentation #53

Closed PieterTack closed 4 years ago

PieterTack commented 4 years ago

corresponds to issue #15

@tschoonj Ik hoop dat deze manier van comments invoegen in de pxd files geen issue zal geven met cython? Ben niet zeker dat deze dergelijke notatie als comments beschouwd.

Ik zou gelijkaardige manier van info in de polycap.pyx file schrijven, en dan in de docs een pagina over python usage invoegen, die de classes met hun functies beschrijft op gelijkaardige wijze? (waar dan bvb de class een hoofdstuk is, een module een subheader, etc etc)

tschoonj commented 4 years ago

Pieter, uw comments moeten terecht komen in polycap.pyx, de pxd files zijn een soort van headers.

PieterTack commented 4 years ago

Zoiets begreep ik ook, maar kdacht voor volledigheid ook in headers commentaar te zetten. (analoog aan de C code waar we comments, die dan werd opgenomen in de docs, ook in headers zetten)

Of kunnen er gewoon geen (multiline) comments in pxd files geschreven worden?

tschoonj commented 4 years ago

Ik zal morgen eens uw build bekijken en hoe het eruitziet in een browser

tschoonj commented 4 years ago

Ik heb hier en daar wat zitten aanpassen. Ik raad u aan dat ge zelf eerst eens de documentatie genereert en kijk of ge overal tevreden mee zijt.