JonBendtsen / dolibarrpy

Python module for interacting with Dolibarr API
MIT License
2 stars 0 forks source link

Maybe a documentation would be enjoyable #1

Open Wishrito opened 3 weeks ago

Wishrito commented 3 weeks ago

I'm new for working with Dolibarr API, well i think a documentation for working with this wrapper would be nice 😊

JonBendtsen commented 3 weeks ago

I'm new for working with Dolibarr API, well i think a documentation for working with this wrapper would be nice 😊

Sounds like a great idea. Can you be a little bit more elaborate as in what the Documentation should contain and which kind of format you think would work well?

Wishrito commented 3 weeks ago

😁hmmm i'll do my best to explain what i thinked about, as i'm french

maybe adding some examples for many basic uses, like how to connect to a dolibarr app, how to extract some data from the user database, etc... oh and an idea would be to type the parameters of the API's functions (as much as possible of course), because it would help to understand what type of data we should send when calling the function 👍